API Docs for: 0.0.8
Show:

ProfileAPI Class

Defined in: client/profile/api.js:13
Module: FxaRelierClient

Constructor

ProfileAPI

(
  • clientId
  • [options={}]
)

Defined in client/profile/api.js:13

Parameters:

  • clientId String
    • the OAuth client ID for the relier
  • [options={}] Object optional
    • configuration
    • [profileHost] String optional

      Firefox Accounts Profile Server host

Item Index

Methods

Methods

all

() Object

Defined in client/profile/api.js:63

Get all the user's profile data. Must be called after fetch

Returns:

Object:

User's profile data that was fetched using fetch.

fetch

(
  • token Scoped
  • [options={}]
)
Promise

Defined in client/profile/api.js:32

Fetch a user's profile data.

Parameters:

  • token Scoped String

    OAuth token that can be used to access the profile data

  • [options={}] Object optional
    • configuration
    • [xhr] String optional

      XMLHttpRequest compatible object to use to make the request.

Returns:

Promise:

Response resolves to the user's profile data on success.