Home Reference Source Test Repository 
import BSD from 'ground-control/backend/bsd.js'
public class | source

BSD

Constructor Summary

Public Constructor
public

constructor(host: *, id: *, secret: *)

Member Summary

Public Members
public

apiId: *

public
public
public

baseURL: *

Method Summary

Public Methods
public

addRSVPToEvent(rsvpDetails: *): *

public

apiInputsFromEvent(event: *): *

public

checkCredentials(email: *, password: *): *

public

cleanField(field: *): *

public

createBundleString(bundles: *): *

public

createConstituent(email: *, firstName: *, lastName: *): *

public

createConstituentObject(constituent: *): *

public

createEvent(event: *): *

public

createGroupObject(group: *): *

public

createSurveyFormFieldObject(formField: *): *

public

createSurveyObject(survey: *): *

public

deleteEvents(eventIdArray: *): *

public

generateBSDURL(callPath: *, params: *, method: *): *

public

getConsIdsForGroup(groupId: *): *

public

getConstituentByEmail(email: *): *

public

getConstituentGroup(groupId: *): *

public

getDeferredResult(deferredId: *): *

public
public

getForm(formId: *): *

public

listFormFields(formId: *): *

public

makeRESTRequest(callPath: *, params: *, method: *): *

public

makeSOAPRequest(callPath: *, params: *, method: *): *

public

noFailApiRequest(method: *, args: ...*): *

public

processSignup(formId: *, formFieldValues: *)

public

request(callPath: *, params: *, method: *): *

public

requestWrapper(options: *): *

public

setConstituentData(cons_id: *, bundleName: *, data: *): *

public

setConstituentPassword(email: *, password: *): string

public

updateEvent(event: *): *

Public Constructors

public constructor(host: *, id: *, secret: *) source

Params:

NameTypeAttributeDescription
host *
id *
secret *

Public Members

public apiId: * source

public apiSecret: * source

public apiVersion: number source

public baseURL: * source

Public Methods

public addRSVPToEvent(rsvpDetails: *): * source

Params:

NameTypeAttributeDescription
rsvpDetails *

Return:

*

public apiInputsFromEvent(event: *): * source

Params:

NameTypeAttributeDescription
event *

Return:

*

public checkCredentials(email: *, password: *): * source

Params:

NameTypeAttributeDescription
email *
password *

Return:

*

public cleanField(field: *): * source

Params:

NameTypeAttributeDescription
field *

Return:

*

public createBundleString(bundles: *): * source

Params:

NameTypeAttributeDescription
bundles *

Return:

*

public createConstituent(email: *, firstName: *, lastName: *): * source

Params:

NameTypeAttributeDescription
email *
firstName *
lastName *

Return:

*

public createConstituentObject(constituent: *): * source

Params:

NameTypeAttributeDescription
constituent *

Return:

*

public createEvent(event: *): * source

Params:

NameTypeAttributeDescription
event *

Return:

*

public createGroupObject(group: *): * source

Params:

NameTypeAttributeDescription
group *

Return:

*

public createSurveyFormFieldObject(formField: *): * source

Params:

NameTypeAttributeDescription
formField *

Return:

*

public createSurveyObject(survey: *): * source

Params:

NameTypeAttributeDescription
survey *

Return:

*

public deleteEvents(eventIdArray: *): * source

Params:

NameTypeAttributeDescription
eventIdArray *

Return:

*

public generateBSDURL(callPath: *, params: *, method: *): * source

Params:

NameTypeAttributeDescription
callPath *
params *
method *

Return:

*

public getConsIdsForGroup(groupId: *): * source

Params:

NameTypeAttributeDescription
groupId *

Return:

*

public getConstituentByEmail(email: *): * source

Params:

NameTypeAttributeDescription
email *

Return:

*

public getConstituentGroup(groupId: *): * source

Params:

NameTypeAttributeDescription
groupId *

Return:

*

public getDeferredResult(deferredId: *): * source

Params:

NameTypeAttributeDescription
deferredId *

Return:

*

public getEventTypes(): * source

Return:

*

public getForm(formId: *): * source

Params:

NameTypeAttributeDescription
formId *

Return:

*

public listFormFields(formId: *): * source

Params:

NameTypeAttributeDescription
formId *

Return:

*

public makeRESTRequest(callPath: *, params: *, method: *): * source

Params:

NameTypeAttributeDescription
callPath *
params *
method *

Return:

*

public makeSOAPRequest(callPath: *, params: *, method: *): * source

Params:

NameTypeAttributeDescription
callPath *
params *
method *

Return:

*

public noFailApiRequest(method: *, args: ...*): * source

Params:

NameTypeAttributeDescription
method *
args ...*

Return:

*

public processSignup(formId: *, formFieldValues: *) source

Params:

NameTypeAttributeDescription
formId *
formFieldValues *

public request(callPath: *, params: *, method: *): * source

Params:

NameTypeAttributeDescription
callPath *
params *
method *

Return:

*

public requestWrapper(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public setConstituentData(cons_id: *, bundleName: *, data: *): * source

Params:

NameTypeAttributeDescription
cons_id *
bundleName *
data *

Return:

*

public setConstituentPassword(email: *, password: *): string source

Params:

NameTypeAttributeDescription
email *
password *

Return:

string

public updateEvent(event: *): * source

Params:

NameTypeAttributeDescription
event *

Return:

*