Home Identifier Source Test Repository 
import Profile from 'buffer-node-api/src/modules/profile.js'
public class | source

Profile

Constructor Summary

Public Constructor
public

constructor(profile: *)

Member Summary

Public Members
public get
public

promise: *

public
public get
public

updates: *

Method Summary

Public Methods
public

getByID(profile_id: Integer, callback: Function)

Gets a single profile by its ID
public

getPendingUpdates(params: Object, callback: Function)

Gets a list of pending updates for a given profile and associates them with this object
public

getSchedules(callback: Function)

Returns the schedules set for the current profile
public

getSentUpdates(params: Object, callback: Function)

Gets a list of sent updates for a given profile and associates them with this object
public

reorderUpdates(params: Object, callback: Function)

Reorders updates in the user's buffer, given a new order
public

setSchedules(schedules: Array, callback: Function)

Overwrites the schedules for the associated profile
public

shuffleUpdates(params: Object, callback: Function)

Shuffles updates in the user's buffer at random

Public Constructors

public constructor(profile: *) source

Params:

NameTypeAttributeDescription
profile *

Public Members

public get pending_updates: * source

public promise: * source

public schedules: * source

public get sent_updates: * source

public updates: * source

Public Methods

public getByID(profile_id: Integer, callback: Function) source

Gets a single profile by its ID

Params:

NameTypeAttributeDescription
profile_id Integer

The ID of the profile to retrieve
callback Function

The callback to run when the request has been fulfilled

public getPendingUpdates(params: Object, callback: Function) source

Gets a list of pending updates for a given profile and associates them with this object

Params:

NameTypeAttributeDescription
params Object

API parameters to pass through to the URL
callback Function

The callback to run when the request has been fulfilled

public getSchedules(callback: Function) source

Returns the schedules set for the current profile

Params:

NameTypeAttributeDescription
callback Function
  • optional

The callback to run when the request has been fulfilled

public getSentUpdates(params: Object, callback: Function) source

Gets a list of sent updates for a given profile and associates them with this object

Params:

NameTypeAttributeDescription
params Object

API parameters to pass through to the URL
callback Function

The callback to run when the request has been fulfilled

public reorderUpdates(params: Object, callback: Function) source

Reorders updates in the user's buffer, given a new order

Params:

NameTypeAttributeDescription
params Object

API parameters to pass through to the URL. "updates" must be present.
callback Function

The callback to run when the request has been fulfilled

public setSchedules(schedules: Array, callback: Function) source

Overwrites the schedules for the associated profile

Params:

NameTypeAttributeDescription
schedules Array

The new schedules to send to the API
callback Function
  • optional

The callback to run when the request has been fulfilled

public shuffleUpdates(params: Object, callback: Function) source

Shuffles updates in the user's buffer at random

Params:

NameTypeAttributeDescription
params Object

The parameters to send to the API
callback Function
  • optional

The callback to run when the request has been fulfilled