Function

afterDelete — executes decorated function after a record delete operation occurs

Example:

const skygearCloud = require('skygear/cloud');¬
skygearCloud.afterDelete('note', function(record, original, pool, options) {
    // cloud code handling the request
    return;
}, {
    async: true
});

afterSave — executes decorated function after a record save operation occurs

Example:

const skygearCloud = require('skygear/cloud');¬
skygearCloud.afterSave('note', function(record, original, pool, options) {
    // cloud code handling the request
    return;
}, {
    async: true
});

beforeDelete — executes decorated function before a record delete operation occurs

Example:

const skygearCloud = require('skygear/cloud');¬
skygearCloud.beforeDelete('note', function(record, original, pool, options) {
    // cloud code handling the request
    return;
}, {
    async: true
});

beforeSave — executes decorated function before a record save operation occurs

Example:

const skygearCloud = require('skygear/cloud');¬
skygearCloud.beforeSave('note', function(record, original, pool, options) {
    // cloud code handling the request
    return;
}, {
    async: true
});

Import and config the cloud code plugin module.

This function will load the specified module by name using the require function. The specified module must exists or an error is thrown.

It is expected that the module will exports a function called includeme. This function will also call the includeme function to config the module.

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

Example:

const skygearCloud = require('skygear/cloud');
skygearCloud.event('after-plugins-ready', function() {
  console.log('Meow');
});

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

Example:

const skygearCloud = require('skygear/cloud');
skygearCloud.every('@daily', function() {
  console.log('Meow');
});

Convert object from JSON representation

It will descends into array and object to convert Skygear Data Type from JSON representation. If the specified value is null, null is returned.

This function is the opposite of toJSON.

Get a configured CloudCodeContainer.

Get redirect link result, return user from redirect based login flow if link success, promise resolve with result { result: 'OK' }. if link fail, promise fail with error. if no redirect flow was called, promise resolve with empty result.

Example:

skygear.auth.getLinkRedirectResult().then(...);

Get redirect login result, return user from redirect based login flow if login success, promise resolve with logged in user. if login fail, promise fail with error. if no redirect flow was called, promise resolve with empty result.

Example:

skygear.auth.getLoginRedirectResult().then(...);

Get current user's provider profiles, can use for determine user logged in provider

Example:

skygear.auth.getOAuthProviderProfiles().then(...);

Return a shared signer for the current configuration.

Get user ID from function parameter.

You can configure the cloud code as an HTTP handler, which can respond to requests coming from outside the SDK. A custom HTTP endpoint can be created using the handler function.

A custom HTTP endpoint can be useful for the followings:

• receiving requests from outside the Skygear SDK
• allowing a third party webhook to call upon (e.g. payment service)

Example:

const skygearCloud = require('skygear/cloud');¬
skygearCloud.handler('handler1', function(req) {
    // cloud code handling the request
    return 'String';
}, {
    method: ['GET', 'POST'],
    userRequired: false
});

skygearCloud.handler('private', function(req, options) {
    // cloud code handling the request
    const {
      context,
      container  // a cloud code container for the current request context
    } = options;
    return {
      status: 'ok',
      user_id: context.user_id // only available if userRequired=true
    };
}, {
    method: ['GET', 'POST'],
    userRequired: true
});

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

Example:

const skygearCloud = require('skygear/cloud');
skygearCloud.hook('before-save', function(newRecord, oldRecord, pool) {
  console.log('Meow');
  return newRecord;
});

Iframe handler script. When getLoginRedirectResult is called, sdk will inject an iframe in the document with plugin iframe handler endpoint the endpoint will call this handler. Handler will get the sso result from browser session and post the result back to parnet

Example:

skygear.auth.iframeHandler().then(...);

Returns whether an object is a Skygear Asset.

Returns whether an object is a Skygear Record.

Link oauth provider with access token

Example:

skygear.auth.linkOAuthProviderWithAccessToken(provider, accessToken).then(...);

Link oauth provider with popup window

Example:

skygear.auth.linkOAuthProviderWithPopup('google').then(...);

Link oauth provider with redirect

Example:

skygear.auth.linkOAuthProviderWithRedirect('google').then(...);

Login oauth provider with access token

Example:

skygear.auth.loginOAuthProviderWithAccessToken(provider, accessToken).then(...);

Login oauth provider with popup window

Example:

skygear.auth.loginOAuthProviderWithPopup('google').then(...);

Login oauth provider with redirect

Example:

skygear.auth.loginOAuthProviderWithRedirect('google').then(...);

Login with custom token.

The custom token is typically created on an external server hosting a user database. This server generates the custom token so that the user on an external server can log in to Skygear Server.

Example:

skygear.auth.loginWithCustomToken('eyXXXXXXXX').then(...);

Auth flow handler script

Example:

skygear.auth.oauthHandler().then(...);

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

This is a convenient way to inject custom logic to Skygear server and can be called easily with skygear.lambda in the client side.

Example:

const skygearCloud = require('skygear/cloud');
skygearCloud.op('greeting', function(param) {
    return {
      'content': 'Hello, ' + param.name,
    };
}, {
    userRequired: false
});

Connect to a pg connection provided by pg pool.

The pg connection is automatically set to use the application's database schema.

Example:

const skygearCloud = require('skygear/cloud');
skygearCloud.poolConnect(function (err, client, done) {
  // if err is undefined or null, make query using the client
  client.query(
    'SELECT id FROM _user WHERE username = $1',
    ['johndoe'],
    function(queryErr, result) {
      done();
      // use the query result here
    }
  );
}

Authentication Provider allows a plugin to authenticate user based on credentials from a third-party. The Authentication Provider responds to Skygear Server whether the credentials are accepted.

Example:

const skygearCloud = require('skygear/cloud');¬

skygearCloud.provides('auth', 'com.facebook', Provider);

Publish multiple events to multiple channels.

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

All asset will be serve with the prefix /static. i.e. if the mount ping is declare as /css. The final URL for requesting assets will be /static/css.

Example:

const skygearCloud = require('skygear/cloud');¬
skygearCloud.staticAsset('/styles', function() {
    // Return the absolute path of the static assets directory
    // http://<yourapp>.skygeario.com/static/styles will be serving files
    // located at '<project_path>/css`
    return __dirname + '/css/';
});

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

Returns the specified value to a JSON representation.

It will descends into array and object to convert Skygear Data Type into JSON representation. If the specified value is null, null is returned.

The output of this function differ from Record.toJSON when specifying a Record. This function will wrap a Record in JSON representation with a $type=record object.

This function is the opposite of fromJSON.

Unlink oauth provider

Example:

skygear.auth.unlinkOAuthProvider(provider).then(...);