Scheduler Service

4. Scheduler

SMS Service.

• Constructor
• [Insert]
• [Get]
• [List]
• [Delete]

swisher_client.Scheduler("appSecret", "appId", [options])

var swisher_client = require('swisher-client'),
    scheduler = swisher_client.Scheduler("7780aa6c75f9439ed416e0501294a3831abe1a05", "8", {
      grantType : "access_token",
      scope     : "test"
    });

scheduler.insert(title, timeZone, startDate, optional, callback)

Parameters:

title (String)

Title of the scheduler event ( Max:500 characters).

timeZone (String)

TimeZone to process the start/end Times( Timezone should be standards TZ string values from TIMEZONES ). ex: Asia/Colombo

startDate (String)

Start date of the scheduling event in the format yyyy-MM-dd.

optional (JSON)

Optional parameters (Empty object such as {} or JSON object provide with key value pairs);

• description (String) Short description of the scheduler event(Max:1000 characters).

• startTime (String) Start time of the scheduling event in the 24 hour format HH:mm:ss.If this not given then event will consider as a whole day event starting from 00:00:00.

• endDate (String) Start date of the scheduling event in the format yyyy-MM-dd.

• endTime (String) Start time of the scheduling event in the 24 hour format HH:mm:ss.If this not given then event will consider as a whole day event starting from 00:00:00.

• location (String) Location of the current event.

• organizer (String) Email Address of the event organizer if available.

• attendees (String) Array of email addresses who attending to current event.These email will get a notification if specified.

• notifyTypes (String) If provided then attendees will get a notification according to the time threshold of the event.Valid notify types are ['email','sms','push'].

• notifyNumbers (String) If notifyType provided as SMS then these are the numbers get notified.

• callbackLink (String) If provided then this url will called (GET request) according to the threshold time.

• thresholds (String) Threshold value ( when to fire the event before it happens).This must be a integer and it will be considered as minutes. ex:5 (this means event will send notifications and execute callBackLink before 5 minutes of its start time).

scheduler.insert(
  "Wake Up Its Christmas!",
  "Asia/Colombo",
  "2014-12-25",
  {
    "description": "Shake up the happiness. Wake up the happiness. Shake up the happiness. Its christmas time",
    "attendees": ["bob@myfriends.com", "john@myfriends.com"],
    "callbackLink": "http://wakeupmydad.com/hay-dad",
    "notifyTypes": ["sms"],
    "notifyNumbers": ["NOBILE_NUMBER1"],
    "startTime": "08:30:00"
  },
  function (err, result) {
    if (err) {
      // Handle Error Here
    } else {
      // -- Code Here
    }
  });

scheduler.get(_id, callback)

Parameters:

_id (String)

_id received from the /insert or /list request which is the unique id of the scheduler event

scheduler.send("75f9439ed416e0501294a3831abe", function(err, result){
  if (err) {
    // Handle Error Here
  } else {
    // -- Code Here
  }
});

scheduler.list(optional, callback)

Should use one of the following key-params.You can have multiple key-value pairs as new POST param set.

Parameters:

optional (JSON)

Optional parameters (Empty object such as {} or JSON object provide with key value pairs);

• title (String) Title of the scheduler event ( Max:500 characters).

• description (String) Short description of the scheduler event(Max:1000 characters).

• timeZone (String) TimeZone to process the start/end Times( Timezone should be standards TZ string values from TIMEZONES ). ex: Asia/Colombo

• startDate (String) Start date of the scheduling event in the format yyyy-MM-dd.

• startTime (String) Start time of the scheduling event in the 24 hour format HH:mm:ss. If this not given then event will consider as a whole day event starting from 00:00:00.

• endDate (String) Start date of the scheduling event in the format yyyy-MM-dd.

• endTime (String) Start time of the scheduling event in the 24 hour format HH:mm:ss. If this not given then event will consider as a whole day event starting from 00:00:00.

• organizer (String) Email Address of the event organizer if available.

scheduler.list({"startDate":"2014-12-25"}, function(err, result){
  if (err) {
    // Handle Error Here
  } else {
    // -- Code Here
  }
});

scheduler.delete(optional, callback)

Should use one of the following key-params.You can have multiple key-value pairs as new POST param set.

Parameters:

optional (JSON)

Optional parameters (Empty object such as {} or JSON object provide with key value pairs);

• title (String) Title of the scheduler event ( Max:500 characters).

• description (String) Short description of the scheduler event(Max:1000 characters).

• timeZone (String) TimeZone to process the start/end Times( Timezone should be standards TZ string values from TIMEZONES ). ex: Asia/Colombo

• startDate (String) Start date of the scheduling event in the format yyyy-MM-dd.

• startTime (String) Start time of the scheduling event in the 24 hour format HH:mm:ss. If this not given then event will consider as a whole day event starting from 00:00:00.

• endDate (String) Start date of the scheduling event in the format yyyy-MM-dd.

• endTime (String) Start time of the scheduling event in the 24 hour format HH:mm:ss. If this not given then event will consider as a whole day event starting from 00:00:00.

• organizer (String) Email Address of the event organizer if available.

scheduler.list({"title":"Wake Up Its Christmas!","startDate":"2014-12-25"}, function(err){
  if (err) {
    // Handle Error Here
  } else {
    // -- Code Here
  }
});