ocall

Documentation

Overview

Package ocall carries some shared utility code for calling the Twitter API v1.1.

Index

• func HasMorePages(req *jape.Request) bool
• func ResetPageToken(req *jape.Request)
• type UsersReply
  • func GetUsers(ctx context.Context, req *jape.Request, opts types.UserFields, ...) (*UsersReply, error)

Functions

func HasMorePages

func HasMorePages(req *jape.Request) bool

HasMorePages reports whether the request has more pages to fetch. This is true for a freshly-constructed request, and for an invoked request where the server not reported a next-page token.

func ResetPageToken

func ResetPageToken(req *jape.Request)

ResetPageToken resets (clears) the request's current page token. Subsequently invoking the query will then fetch the first page of results.

Types

type UsersReply

type UsersReply struct {
	Data      []byte
	Users     []*types.User
	NextToken string
}

A UsersReply is the response from a request that returns users.

func GetUsers

func GetUsers(ctx context.Context, req *jape.Request, opts types.UserFields, cli *twitter.Client) (*UsersReply, error)

GetUsers invokes an API method that returns API v1.1 user objects and pagination metadata.