Class Index | File Index

Classes


Class mbo_SiteService


Defined in: mbo_SiteService.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
mbo_SiteService(username, password)
Represents the MINDOBDY Site Service.
Method Summary
Method Attributes Method Name and Description
 
Retrieves activation codes for the Site required for API access.
 
Retrieves activation codes for the Site required for API access.
 
Returns whether or not the SourceCredentials have access to a site.
Class Detail
mbo_SiteService(username, password)
Represents the MINDOBDY Site Service.
Parameters:
{string} username
Username of the MINDBODY client interacting with the service.
{string} password
Password of the MINDBODY client interacting with the service.
Returns:
{mbo_SiteService} Returns the Site Service.
Method Detail
{Promise} GetActivationCode()
Retrieves activation codes for the Site required for API access. These must be given to the site's owner to be granted access. Overwrites the automatically generated function due to a non-standard response format.
Returns:
{Promise} An A+ Promise passed an object containing: i) ActivationCode: The raw activation code ii) ActivationLink: The link to grant access

{Promise} getActivationCodes()
Retrieves activation codes for the Site required for API access. These must be given to the site's owner to be granted access.
Returns:
{Promise} An A+ Promise passed an object containing: i) code: The raw activation code ii) link: The link to grant access

{Promise} hasSiteAccess(id)
Returns whether or not the SourceCredentials have access to a site.
Parameters:
{number} id
The id of the site to check.
Returns:
{Promise} Returns an A+ Promise resolved to true if the credentials have site access, false otherwise.

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Jul 22 2018 23:41:33 GMT+0200 (CEST)