import Container from 'skygear-build/packages/skygear-core/lib/container.js'

public class | source

Container

BaseContainer → Container

Container provides configuration for connecting to Skygear server, and accessors to other containers, providing various functionalities:

skygear.auth - AuthContainer: User authentications and user roles API.
skygear.relation - RelationContainer: User relation API, like add and query Friends.
skygear.privateDB - Database: Private database of the current user, with record API, like query, save and delete.
skygear.publicDB - PublicDatabase: Public database, providing the same record API as Database, but with additional record role API.
skygear.pubsub - PubsubContainer: A publish-subscribe interface, providing real-time message-based communication with other users.
skygear.push - PushContainer: Push Notifications.

Constructor Summary

Public Constructor
public	constructor()

Public Members
public get	auth: AuthContainer
public get	privateDB: Database
public get	publicDB: PublicDatabase
public get	pubsub: PubsubContainer
public get	push: PushContainer
public get	relation: RelationContainer
public	timeoutOptions: Object Options for how much time to wait for client request to complete.

Public Methods
public	async config(options: Object): Promise<Container> Sets a new end point and new API key to the container.

From class BaseContainer
public static get	VERSION: String The version of Skygear.
public get	ACL: ACL
public get	Asset: Asset
public get	AuthContainer: AuthContainer
public get	Database: Database
public get	DatabaseContainer: DatabaseContainer
public get	Error: SkygearError
public get	ErrorCodes: ErrorCodes
public get	Follower: Relation
public get	Following: Relation
public get	Friend: Relation
public get	Geolocation: Geolocation
public get	PubsubContainer: PubsubContainer
public get	PushContainer: PushContainer
public get	Query: Query
public get	Record: Record
public get	Reference: Reference
public get	RelationContainer: RelationContainer
public get	Role: Role
public get	Sequence: Sequence
public get	UserRecord: Record
public get	VERSION: String The version of Skygear.
public get	endPoint: String Endpoint of the skygear container
public set	endPoint: String Endpoint of the skygear container
public	apiKey: String API key of the skygear container
public	async clearCache(): Promise Clears all cache in skygear container store.
public	async config(options: Object): Promise<BaseContainer> Sets a new end point and new API key to the container.
public	configApiKey(apiKey: String) Sets a new API key to the container.
public	configEndPoint(endPoint: String) Sets a new end point to the container.
public	async lambda(name: String, data: Object): Promise<Object> Calls a registered lambda function without arguments.

Options for how much time to wait for client request to complete.

Name	Type	Attribute	Description
timeoutOptions.deadline	number	optional	deadline for the request and response to complete (in milliseconds)
timeoutOptions.response	number	optional default: 60000	maximum time to wait for an response (in milliseconds)

Sets a new end point and new API key to the container.

After configuration,

Name	Type	Attribute	Description
options	Object		configuration options of the skygear container
options.apiKey	String		api key
options.endPoint	String		end point

promise with the skygear container