facebook: github.com/huandu/facebook Index | Files

package facebook

import "github.com/huandu/facebook"

Package facebook is a Go library fully supports Facebook Graph API (both 1.0 and 2.x) with file upload, batch request, FQL and multi-FQL. It can be used in Google App Engine.

Library design is highly influenced by facebook official PHP/JS SDK. If you have experience with PHP/JS SDK, you may feel quite familiar with it.

Go to project home page to see samples. Link: https://github.com/huandu/facebook

This library doesn't implement any deprecated old RESTful API. And it won't.

Index

Package Files

api.go app.go batch_result.go conversion.go error.go filedata.go paging_result.go params.go result.go session.go

Constants

const (
    ERROR_CODE_UNKNOWN = -1 // unknown facebook graph api error code.

)

Variables

var (
    // Version is the default facebook api version.
    // It can be any valid version string (e.g. "v2.3") or empty.
    //
    // See https://developers.facebook.com/docs/apps/versions for details.
    Version string

    // Debug is the app level debug mode.
    // After setting DebugMode, all newly created session will use the mode
    // to communicate with graph API.
    //
    // See https://developers.facebook.com/docs/graph-api/using-graph-api/v2.3#debugging
    Debug DebugMode

    // RFC3339Timestamps will cause all requests to return RFC3339 formatted timestamps.
    // RFC3339 is the timestamp format that the built in UnmarshalJSON expects.
    RFC3339Timestamps bool
)

func SetHttpClient Uses

func SetHttpClient(client HttpClient)

SetHttpClient updates the http client of default session.

type App Uses

type App struct {
    // Facebook app id
    AppId string

    // Facebook app secret
    AppSecret string

    // Facebook app redirect URI in the app's configuration.
    RedirectUri string

    // Enable appsecret proof in every API call to facebook.
    // Facebook document: https://developers.facebook.com/docs/graph-api/securing-requests
    EnableAppsecretProof bool
}

App holds facebook application information.

func New Uses

func New(appID, appSecret string) *App

New creates a new App and sets app id and secret.

func (*App) AppAccessToken Uses

func (app *App) AppAccessToken() string

AppAccessToken gets application access token, useful for gathering public information about users and applications.

func (*App) ExchangeToken Uses

func (app *App) ExchangeToken(accessToken string) (token string, expires int, err error)

ExchangeToken exchanges a short-lived access token to a long-lived access token. Return new access token and its expires time.

func (*App) GetCode Uses

func (app *App) GetCode(accessToken string) (code string, err error)

GetCode gets code from a long lived access token. Return the code retrieved from facebook.

func (*App) ParseCode Uses

func (app *App) ParseCode(code string) (token string, err error)

ParseCode redeems code for a valid access token. It's a shorthand call to ParseCodeInfo(code, "").

In facebook PHP SDK, there is a CSRF state to avoid attack. That state is not checked in this library. Caller is responsible to store and check state if possible.

func (*App) ParseCodeInfo Uses

func (app *App) ParseCodeInfo(code, machineID string) (token string, expires int, newMachineID string, err error)

ParseCodeInfo redeems code for access token and returns extra information. The machineId is optional.

See https://developers.facebook.com/docs/facebook-login/access-tokens#extending

func (*App) ParseSignedRequest Uses

func (app *App) ParseSignedRequest(signedRequest string) (res Result, err error)

ParseSignedRequest parses signed request.

func (*App) Session Uses

func (app *App) Session(accessToken string) *Session

Session creates a session based on current App setting.

func (*App) SessionFromSignedRequest Uses

func (app *App) SessionFromSignedRequest(signedRequest string) (session *Session, err error)

SessionFromSignedRequest creates a session from a signed request. If signed request contains a code, it will automatically use this code to exchange a valid access token.

type BatchResult Uses

type BatchResult struct {
    StatusCode int         // HTTP status code.
    Header     http.Header // HTTP response headers.
    Body       string      // Raw HTTP response body string.
    Result     Result      // Facebook api result parsed from body.
}

BatchResult represents facebook batch API call result. See https://developers.facebook.com/docs/graph-api/making-multiple-requests/#multiple_methods.

type BinaryData Uses

type BinaryData struct {
    Filename    string    // filename used in multipart form writer.
    Source      io.Reader // file data source.
    ContentType string    // content type of the data.
}

BinaryData represents binary data from a given source.

func Data Uses

func Data(filename string, source io.Reader) *BinaryData

Data creates new binary data holder.

func DataWithContentType Uses

func DataWithContentType(filename string, source io.Reader, contentType string) *BinaryData

DataWithContentType creates new binary data holder with arbitrary content type.

type BinaryFile Uses

type BinaryFile struct {
    Filename    string // filename used in multipart form writer.
    Path        string // path to file. must be readable.
    ContentType string // content type of the file.
}

BinaryFile represents a file on disk.

func File Uses

func File(filename string) *BinaryFile

File creates a binary file holder.

func FileAlias Uses

func FileAlias(filename, path string) *BinaryFile

FileAlias creates a binary file holder and specific a different path for reading.

func FileAliasWithContentType Uses

func FileAliasWithContentType(filename, path, contentType string) *BinaryFile

FileAliasWithContentType creates a new binary file holder with arbitrary content type.

type DebugInfo Uses

type DebugInfo struct {
    Messages []DebugMessage // debug messages. it can be nil if there is no message.
    Header   http.Header    // all HTTP headers for this response.
    Proto    string         // HTTP protocol name for this response.

    // Facebook debug HTTP headers.
    FacebookApiVersion string // the actual graph API version provided by facebook-api-version HTTP header.
    FacebookDebug      string // the X-FB-Debug HTTP header.
    FacebookRev        string // the x-fb-rev HTTP header.
}

DebugInfo is the debug information returned by facebook when debug mode is enabled.

type DebugMessage Uses

type DebugMessage struct {
    Type    string
    Message string
    Link    string
}

DebugMessage is one debug message in "__debug__" of graph API response.

type DebugMode Uses

type DebugMode string

DebugMode is the debug mode of Graph API. See https://developers.facebook.com/docs/graph-api/using-graph-api/v2.3#graphapidebugmode

const (
    DEBUG_OFF DebugMode = "" // turn off debug.

    DEBUG_ALL     DebugMode = "all"
    DEBUG_INFO    DebugMode = "info"
    DEBUG_WARNING DebugMode = "warning"
)

Graph API debug mode values.

type Error Uses

type Error struct {
    Message      string
    Type         string
    Code         int
    ErrorSubcode int    // subcode for authentication related errors.
    UserTitle    string `json:"error_user_title"`
    UserMessage  string `json:"error_user_msg"`
    IsTransient  bool   `json:"is_transient"`
    TraceID      string `json:"fbtrace_id"`
}

Error represents Facebook API error.

func (*Error) Error Uses

func (e *Error) Error() string

Error returns error string.

type Float32 Uses

type Float32 float32

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Float64 Uses

type Float64 float64

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type HttpClient Uses

type HttpClient interface {
    Do(req *http.Request) (resp *http.Response, err error)
    Get(url string) (resp *http.Response, err error)
    Post(url string, bodyType string, body io.Reader) (resp *http.Response, err error)
}

HttpClient is an interface to send http request. This interface is designed to be compatible with type `*http.Client`.

func DefaultHttpClient Uses

func DefaultHttpClient() HttpClient

DefaultHttpClient returns the http client for default session.

type Int Uses

type Int int

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Int16 Uses

type Int16 int16

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Int32 Uses

type Int32 int32

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Int64 Uses

type Int64 int64

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Int8 Uses

type Int8 int8

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Method Uses

type Method string

Method is HTTP method for an API call. Can be GET, POST or DELETE.

const (
    GET    Method = "GET"
    POST   Method = "POST"
    DELETE Method = "DELETE"
    PUT    Method = "PUT"
)

Facebook graph api methods.

type PagingResult Uses

type PagingResult struct {
    // contains filtered or unexported fields
}

PagingResult represents facebook API call result with paging information.

func (*PagingResult) Data Uses

func (pr *PagingResult) Data() []Result

Data gets current data.

func (*PagingResult) Decode Uses

func (pr *PagingResult) Decode(v interface{}) (err error)

Decode decodes the current full result to a struct. See Result#Decode.

func (*PagingResult) HasNext Uses

func (pr *PagingResult) HasNext() bool

HasNext checks whether there is next page.

func (*PagingResult) HasPrevious Uses

func (pr *PagingResult) HasPrevious() bool

HasPrevious checks whether there is previous page.

func (*PagingResult) Next Uses

func (pr *PagingResult) Next() (noMore bool, err error)

Next reads next page.

func (*PagingResult) Previous Uses

func (pr *PagingResult) Previous() (noMore bool, err error)

Previous reads previous page.

type Params Uses

type Params map[string]interface{}

API params.

For general uses, just use Params as an ordinary map.

For advanced uses, use MakeParams to create Params from any struct.

func MakeParams Uses

func MakeParams(data interface{}) (params Params)

Makes a new Params instance by given data. Data must be a struct or a map with string keys. MakeParams will change all struct field name to lower case name with underscore. e.g. "FooBar" will be changed to "foo_bar".

Returns nil if data cannot be used to make a Params instance.

func (Params) Encode Uses

func (params Params) Encode(writer io.Writer) (mime string, err error)

Encodes params to query string. If map value is not a string, Encode uses json.Marshal() to convert value to string.

Encode will panic if Params contains values that cannot be marshalled to json string.

type Result Uses

type Result map[string]interface{}

Result is Facebook API call result.

func Api Uses

func Api(path string, method Method, params Params) (Result, error)

Api makes a facebook graph api call with default session.

Method can be GET, POST, DELETE or PUT.

Params represents query strings in this call. Keys and values in params will be encoded into the URL automatically, so there is no need to encode keys or values in params manually. Params can be nil.

If you want to get

https://graph.facebook.com/huandu?fields=name,username

Api should be called as following

Api("/huandu", GET, Params{"fields": "name,username"})

or in a simplified way

Get("/huandu", Params{"fields": "name,username"})

Api is a wrapper of Session.Api(). It's designed for graph api that doesn't require app id, app secret and access token. It can be called in multiple goroutines.

If app id, app secret or access token is required in graph api, caller should create a new facebook session through App instance instead.

func Batch Uses

func Batch(batchParams Params, params ...Params) ([]Result, error)

Batch makes a batch facebook graph api call with default session. Batch is designed for more advanced usage including uploading binary files.

An uploading files sample

// equivalent to following curl command (borrowed from facebook docs)
//     curl \
//         -F 'access_token=…' \
//         -F 'batch=[{"method":"POST","relative_url":"me/photos","body":"message=My cat photo","attached_files":"file1"},{"method":"POST","relative_url":"me/photos","body":"message=My dog photo","attached_files":"file2"}]' \
//         -F 'file1=@cat.gif' \
//         -F 'file2=@dog.jpg' \
//         https://graph.facebook.com
Batch(Params{
    "access_token": "the-access-token",
    "file1": File("cat.gif"),
    "file2": File("dog.jpg"),
}, Params{
    "method": "POST",
    "relative_url": "me/photos",
    "body": "message=My cat photo",
    "attached_files": "file1",
}, Params{
    "method": "POST",
    "relative_url": "me/photos",
    "body": "message=My dog photo",
    "attached_files": "file2",
})

Facebook document: https://developers.facebook.com/docs/graph-api/making-multiple-requests

func BatchApi Uses

func BatchApi(accessToken string, params ...Params) ([]Result, error)

BatchApi makes a batch facebook graph api call with default session.

BatchApi supports most kinds of batch calls defines in facebook batch api document, except uploading binary data. Use Batch to do so.

Note: API response is stored in "body" field of a Result.

results, _ := BatchApi(accessToken, Params{...}, Params{...})

// Use first batch api response.
var res1 *BatchResult
var err error
res1, err = results[0].Batch()

if err != nil {
    // this is not a valid batch api response.
}

// Use BatchResult#Result to get response body content as Result.
res := res1.Result

Facebook document: https://developers.facebook.com/docs/graph-api/making-multiple-requests

func Delete Uses

func Delete(path string, params Params) (Result, error)

Delete is a short hand of Api(path, DELETE, params).

func Get Uses

func Get(path string, params Params) (Result, error)

Get is a short hand of Api(path, GET, params).

func MakeResult Uses

func MakeResult(jsonBytes []byte) (Result, error)

MakeResult makes a Result from facebook Graph API response.

func Post Uses

func Post(path string, params Params) (Result, error)

Post is a short hand of Api(path, POST, params).

func Put Uses

func Put(path string, params Params) (Result, error)

Put is a short hand of Api(path, PUT, params).

func Request Uses

func Request(request *http.Request) (Result, error)

Request makes an arbitrary HTTP request with default session. It expects server responses a facebook Graph API response.

request, _ := http.NewRequest("https://graph.facebook.com/538744468", "GET", nil)
res, err := Request(request)
fmt.Println(res["gender"])  // get "male"

func (Result) Batch Uses

func (res Result) Batch() (*BatchResult, error)

Batch creates a BatchResult for this result and returns error if the Result is not a batch api response.

See BatchApi document for a sample usage.

func (Result) DebugInfo Uses

func (res Result) DebugInfo() *DebugInfo

DebugInfo creates a DebugInfo for this result if this result has "__debug__" key.

func (Result) Decode Uses

func (res Result) Decode(v interface{}) (err error)

Decode decodes full result to a struct. It only decodes fields defined in the struct.

As all facebook response fields are lower case strings, Decode will convert all camel-case field names to lower case string. e.g. field name "FooBar" will be converted to "foo_bar". The side effect is that if a struct has 2 fields with only capital differences, decoder will map these fields to a same result value.

If a field is missing in the result, Decode keeps it unchanged by default.

The decoding of each struct field can be customized by the format string stored under the "facebook" key or the "json" key in the struct field's tag. The "facebook" key is recommended as it's specifically designed for this package.

Examples:

type Foo struct {
    // "id" must exist in response. note the leading comma.
    Id string `facebook:",required"`

    // use "name" as field name in response.
    TheName string `facebook:"name"`

    // the "json" key also works as expected.
    Key string `json:"my_key"`

    // if both "facebook" and "json" key are set, the "facebook" key is used.
    Value string `facebook:"value" json:"shadowed"`
}

To change default behavior, set a struct tag `facebook:",required"` to fields should not be missing.

Returns error if v is not a struct or any required v field name absents in res.

func (Result) DecodeField Uses

func (res Result) DecodeField(field string, v interface{}) error

DecodeField decodes a field of result to any type, including struct. Field name format is defined in Result.Get().

More details about decoding struct see Result.Decode().

func (Result) Err Uses

func (res Result) Err() error

Err returns an error if Result is a Graph API error.

The returned error can be converted to Error by type assertion.

err := res.Err()
if err != nil {
    if e, ok := err.(*Error); ok {
        // read more details in e.Message, e.Code and e.Type
    }
}

For more information about Graph API Errors, see https://developers.facebook.com/docs/reference/api/errors/

func (Result) Get Uses

func (res Result) Get(field string) interface{}

Get gets a field from Result.

Field can be a dot separated string. If field name is "a.b.c", it will try to return value of res["a"]["b"]["c"].

To access array items, use index value in field. For instance, field "a.0.c" means to read res["a"][0]["c"].

It doesn't work with Result which has a key contains dot. Use GetField in this case.

Returns nil if field doesn't exist.

func (Result) GetField Uses

func (res Result) GetField(fields ...string) interface{}

GetField gets a field from Result.

Arguments are treated as keys to access value in Result. If arguments are "a","b","c", it will try to return value of res["a"]["b"]["c"].

To access array items, use index value as a string. For instance, args of "a", "0", "c" means to read res["a"][0]["c"].

Returns nil if field doesn't exist.

func (Result) Paging Uses

func (res Result) Paging(session *Session) (*PagingResult, error)

Paging creates a PagingResult for this Result and returns error if the Result cannot be used for paging.

Facebook uses following JSON structure to response paging information. If "data" doesn't present in Result, Paging will return error.

{
    "data": [...],
    "paging": {
        "previous": "https://graph.facebook.com/...",
        "next": "https://graph.facebook.com/..."
    }
}

func (Result) UsageInfo Uses

func (res Result) UsageInfo() *UsageInfo

UsageInfo returns app and page usage info (rate limits)

type Session Uses

type Session struct {
    HttpClient        HttpClient
    Version           string // facebook versioning.
    RFC3339Timestamps bool   // set to true to send date_format=Y-m-d\TH:i:sP on every request which will cause RFC3339 style timestamps to be returned
    BaseURL           string // set to override API base URL - trailing slash is required, e.g. http://127.0.0.1:53453/
    // contains filtered or unexported fields
}

Session holds a facebook session with an access token. Session should be created by App.Session or App.SessionFromSignedRequest.

func (*Session) AccessToken Uses

func (session *Session) AccessToken() string

AccessToken gets current access token.

func (*Session) Api Uses

func (session *Session) Api(path string, method Method, params Params) (Result, error)

Api makes a facebook graph api call.

If session access token is set, "access_token" in params will be set to the token value.

Returns facebook graph api call result. If facebook returns error in response, returns error details in res and set err.

func (*Session) App Uses

func (session *Session) App() *App

App gets associated App.

func (*Session) AppsecretProof Uses

func (session *Session) AppsecretProof() string

AppsecretProof checks appsecret proof is enabled or not.

func (*Session) Batch Uses

func (session *Session) Batch(batchParams Params, params ...Params) ([]Result, error)

Batch makes a batch facebook graph api call. Batch is designed for more advanced usage including uploading binary files.

If session access token is set, "access_token" in batchParams will be set to the token value.

Facebook document: https://developers.facebook.com/docs/graph-api/making-multiple-requests

func (*Session) BatchApi Uses

func (session *Session) BatchApi(params ...Params) ([]Result, error)

BatchApi makes a batch call. Each params represent a single facebook graph api call.

BatchApi supports most kinds of batch calls defines in facebook batch api document, except uploading binary data. Use Batch to upload binary data.

If session access token is set, the token will be used in batch api call.

Returns an array of batch call result on success.

Facebook document: https://developers.facebook.com/docs/graph-api/making-multiple-requests

func (*Session) Context Uses

func (session *Session) Context() context.Context

Context returns the session's context. To change the context, use `Session#WithContext`.

The returned context is always non-nil; it defaults to the background context. For outgoing Facebook API requests, the context controls timeout/deadline and cancelation.

func (*Session) Debug Uses

func (session *Session) Debug() DebugMode

Debug returns current debug mode.

func (*Session) Delete Uses

func (session *Session) Delete(path string, params Params) (Result, error)

Delete is a short hand of Api(path, DELETE, params).

func (*Session) EnableAppsecretProof Uses

func (session *Session) EnableAppsecretProof(enabled bool) error

EnableAppsecretProof enables or disable appsecret proof status. Returns error if there is no App associated with this Session.

func (*Session) Get Uses

func (session *Session) Get(path string, params Params) (Result, error)

Get is a short hand of Api(path, GET, params).

func (*Session) Inspect Uses

func (session *Session) Inspect() (result Result, err error)

Inspect Session access token. Returns JSON array containing data about the inspected token. See https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow/#checktoken

func (*Session) Post Uses

func (session *Session) Post(path string, params Params) (Result, error)

Post is a short hand of Api(path, POST, params).

func (*Session) Put Uses

func (session *Session) Put(path string, params Params) (Result, error)

Put is a short hand of Api(path, PUT, params).

func (*Session) Request Uses

func (session *Session) Request(request *http.Request) (res Result, err error)

Request makes an arbitrary HTTP request. It expects server responses a facebook Graph API response.

request, _ := http.NewRequest("https://graph.facebook.com/538744468", "GET", nil)
res, err := session.Request(request)
fmt.Println(res["gender"])  // get "male"

func (*Session) SetAccessToken Uses

func (session *Session) SetAccessToken(token string)

SetAccessToken sets a new access token.

func (*Session) SetDebug Uses

func (session *Session) SetDebug(debug DebugMode) DebugMode

SetDebug updates per session debug mode and returns old mode. If per session debug mode is DEBUG_OFF, session will use global Debug mode.

func (*Session) User Uses

func (session *Session) User() (id string, err error)

User gets current user id from access token.

Returns error if access token is not set or invalid.

It's a standard way to validate a facebook access token.

func (*Session) Validate Uses

func (session *Session) Validate() (err error)

Validate validates Session access token. Returns nil if access token is valid.

func (*Session) WithContext Uses

func (session *Session) WithContext(ctx context.Context) *Session

WithContext returns a shallow copy of session with its context changed to ctx. The provided ctx must be non-nil.

type Uint Uses

type Uint uint

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Uint16 Uses

type Uint16 uint16

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Uint32 Uses

type Uint32 uint32

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Uint64 Uses

type Uint64 uint64

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type Uint8 Uses

type Uint8 uint8

Special number types which can be decoded from either a number or a string. If developers intend to use a string in JSON as a number, these types can parse string to a number implicitly in `Result#Decode` or `Result#DecodeField`.

Caveats: Parsing a string to a number may lose accuracy or shadow some errors.

type UsageInfo Uses

type UsageInfo struct {
    App struct {
        CallCount    int `json:"call_count"`
        TotalTime    int `json:"total_time"`
        TotalCPUTime int `json:"total_cputime"`
    }   `json:"app"`
    Page struct {
        CallCount    int `json:"call_count"`
        TotalTime    int `json:"total_time"`
        TotalCPUTime int `json:"total_cputime"`
    }   `json:"page"`
}

UsageInfo is the app usage (rate limit) information returned by facebook when rate limits are possible.

Package facebook imports 25 packages (graph) and is imported by 49 packages. Updated 2018-11-19. Refresh now. Tools for package owners.