Home Reference Source

References

skygear-core/lib

summary
public

C ACL

Access Control List

public

C Asset

Asset

public

Auth container

public

BaseContainer provides the basic configuration for connecting to a Skygear server.

public

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.
public
public
public

SkygearError is an error object containing information of an error occurred.

public

Geolocation

public

C Pubsub

The Pubsub client

public

Pubsub container

public

Push container

public

C Query

Query object provides database query functions.

public

Copyright 2015 Oursky Ltd.

public

C Record

Record provides the model for Skygear Database to interact with server.

public

Reference

public

Relation

public
public

Result of query relation API

public

Result of remove relation API

public

Result of add relation API

public

C Role

Role

public

Sequence

public

UnknownValue

public
public

F isAsset(obj: *): Boolean

Returns whether an object is a Skygear Asset.

public

F isRecord(obj: *): Boolean

Returns whether an object is a Skygear Record.

public

F fromJSON(attrs: Object): Object

Convert object from JSON representation

public

F isLocalStorageValid(): boolean

public

F isValueType(value: *): *

public

F toJSON(v: Object): Object

Returns the specified value to a JSON representation.

public

V AccessLevel: {"NoAccessLevel": *, "ReadOnlyLevel": string, "ReadWriteLevel": string}

public

V USER_CHANGED: string

public
public

V ErrorCodes: {"NotAuthenticated": number, "PermissionDenied": number, "AccessKeyNotAccepted": number, "AccessTokenNotAccepted": number, "InvalidCredentials": number, "InvalidSignature": number, "BadRequest": number, "InvalidArgument": number, "Duplicated": number, "ResourceNotFound": number, "NotSupported": number, "NotImplemented": number, "ConstraintViolated": number, "IncompatibleSchema": number, "AtomicOperationFailure": number, "PartialOperationFailure": number, "UndefinedOperation": number, "PluginUnavailable": number, "PluginTimeout": number, "RecordQueryInvalid": number, "PluginInitializing": number, "ResponseTimeout": number, "DeniedArgument": number, "RecordQueryDenied": number, "NotConfigured": number, "PasswordPolicyViolated": number, "UserDisabled": number, "VerificationRequired": number, "AssetSizeTooLarge": number, "UnexpectedError": number}

Enum for error codes

public

V Inward: String

Inward relation direction

public

V Mutual: String

Mutual relation direction

public

V Outward: String

Outward relation direction

skygear-core/lib/cloud

summary
public
public
public
public
public
public

BaseAuthProvider provides example interface that an AuthProvider should provide.

public
public
public

Return a shared signer for the current configuration.

public

F staticAssetHandler(req: *): *

staticAssetHandler — default handler for serving static assets with during development.

public

F getContainer(userId: String): CloudCodeContainer

Get a configured CloudCodeContainer.

public

F async publishEventsToChannels(channels: String[], eventsData: Object[]): Promise<CloudCodeContainer>

Publish multiple events to multiple channels.

public

F afterDelete(recordType: string, func: function(record: lib/record.js~Record, originalRecord: lib/record.js~Record, pool: pool, options: *): *, options: Object)

afterDelete — executes decorated function after a record delete operation occurs

public

F afterSave(recordType: string, func: function(record: lib/record.js~Record, originalRecord: lib/record.js~Record, pool: pool, options: *): *, options: Object)

afterSave — executes decorated function after a record save operation occurs

public

F beforeDelete(recordType: string, func: function(record: lib/record.js~Record, originalRecord: lib/record.js~Record, pool: pool, options: *): *, options: Object)

beforeDelete — executes decorated function before a record delete operation occurs

public

F beforeSave(recordType: string, func: function(record: lib/record.js~Record, originalRecord: lib/record.js~Record, pool: pool, options: *): *, options: Object)

beforeSave — executes decorated function before a record save operation occurs

public

F async configModule(moduleName: *, options: *)

Import and config the cloud code plugin module.

public

F event(name: String, func: function(param: *), options: Object)

You can register the cloud code to run at skygear life cycle event.

public

F every(cron: String, func: function(param: *), options: Object)

You can register the cloud code to get run at specific time intervals like a cron job.

public

F handler(path: string, func: function(request: *, options: *): object, options: Object)

You can configure the cloud code as an HTTP handler, which can respond to requests coming from outside the SDK.

public

F hook(name: String, func: function(newRecord: *, oldRecord: *, pool: *, options: *), options: Object)

You can register the cloud code to run at database event.

public

F op(name: String, func: function(param: Object, options: *), options: Object)

You can register the cloud code as lambda, with JSON input and output.

public

F provides(providerType: string, providerID: string, ProviderCls: object, options: object)

Authentication Provider allows a plugin to authenticate user based on credentials from a third-party.

public

F staticAsset(mountPoint: string, func: function(): string)

staticAsset — declare certain path to be serve in static asset.

public

F createLogger(name: *, context: {}, opts: {}): *

public

F poolConnect(callback: function(err: *, client: *, done: function): *)

Connect to a pg connection provided by pg pool.

public

F parseInteger(val: *, defaultValue: *): *

public
public

V ErrorCodes: *

public
public

V log: *

public

V pool: *

public

V settings: *

public

V skyconfig: *

public

V pool: *

Database connection pool of the Skygear PostgreSQL database.

public
public

V settings: {"skygearAddress": *, "skygearEndpoint": *, "apiKey": *, "masterKey": *, "appName": *, "logLevel": *, "logFormat": *, "http": *, "debug": *, "pubsubURL": *, "serveStaticAssets": *, "collectAsset": *, "forceAsset": *, "databaseURL": *, "pgPoolMax": *, "pgPoolMin": *, "pgPoolIdleTimeoutMillis": *, "assetStore": *, "assetStoreSecret": *, "assetStoreURLPrefix": *, "assetStoreURLExpireDuration": *, "assetStoreS3AccessKey": *, "assetStoreS3SecretKey": *, "assetStoreS3Bucket": *, "assetStoreS3Region": *, "assetStoreS3URLPrefix": *, "cloudAssetHost": *, "cloudAssetToken": *, "cloudAssetStorePublic": *, "cloudAssetPublicPrefix": *, "cloudAssetPrivatePrefix": *, "loadModules": *}

public

V config: {}

Copyright 2015 Oursky Ltd.

skygear-core/lib/cloud/transport

summary
public
public

This is thin response object trying to provide a http.ServerResponse like interface for setting response headers and body.

public
public

skygear-core/lib/react-native

summary
public

skygear-sso/lib

summary
public
public
public

F errorResponseFromMessage(message: *): {"error": *}