### Home Classes Methods

### In Files

- lib/github_api/page_links.rb

### Parent

Object

### Methods

- ::new

### Included Modules

- Github::Constants

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::PageLinks

Determines the links in the current response link header to be used to find the links to other pages of request responses. These will only be present if the result set size exceeds the per page limit.

### Constants

DELIM_LINKS

### Attributes

first[RW]

Hold the extracted values for URI from the Link header for the first, last, next and previous page.

last[RW]

Hold the extracted values for URI from the Link header for the first, last, next and previous page.

next[RW]

Hold the extracted values for URI from the Link header for the first, last, next and previous page.

prev[RW]

Hold the extracted values for URI from the Link header for the first, last, next and previous page.

### Public Class Methods

new(response_headers) click to toggle source

Parses links from executed request

    # File lib/github_api/page_links.rb, line 16
    def initialize(response_headers)
      link_header = response_headers[HEADER_LINK]
      if link_header
        return unless link_header =~ /(next|first|last|prev)/

        link_header.split(DELIM_LINKS).each do |link|
          if link.strip =~ /<([^>]+)>; rel=\"([^\"]+)\"/
            url_part, meta_part = $1, $2
            next if !url_part || !meta_part
            case meta_part
            when META_FIRST
              self.first = url_part
            when META_LAST
              self.last = url_part
            when META_NEXT
              self.next = url_part
            when META_PREV
              self.prev = url_part
            end
          end
        end
      else
        # When on the first page
        self.next = response_headers[HEADER_NEXT]
        self.last = response_headers[HEADER_LAST]
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.