Interface ScriptAccountManager

An AccountManager can be used to control user accounts.

It supports creating, updating and retrieving accounts.

It may also support registration and associating devices with user accounts.

Hierarchy

ScriptAccountManager

Index

Methods

activateAccount addDeviceForUser createAccount deleteAccount deleteDevice ensureNonDuplicateAccount getByEmail getByPhone getByUserName getDevicesByUserName initializeActivation isSetPasswordAfterActivation listLinksByAccountId listLinksBySubject resolveLink supportsRegistration updateAccount

Methods

activateAccount

activateAccount(token: null | string): ScriptAccountManager$ScriptActivationResult
Parameters
- token: null | string
Returns ScriptAccountManager$ScriptActivationResult
- Defined in typescript-definitions.ts:2717

addDeviceForUser

addDeviceForUser(username: null | string, deviceId: null | string, deviceAlias: null | string, deviceNumber: null | string, formFactor: null | string, type: null | string, expiresAt: Instant): void
Add a device with the given characteristics and associate it with the account of the given user.
Parameters
- username: null | string
- deviceId: null | string
- deviceAlias: null | string
- deviceNumber: null | string
- formFactor: null | string
- type: null | string
- expiresAt: Instant
Returns void
- Defined in typescript-definitions.ts:2730
addDeviceForUser(parameters: DeviceMap): void
Add a device with the given characteristics and associate it with the account of the given user.
Parameters
- parameters: DeviceMap
Returns void
- Defined in typescript-definitions.ts:2737

createAccount

createAccount(account: null | AccountAttributes): void
Parameters
- account: null | AccountAttributes
Returns void
- Defined in typescript-definitions.ts:2743
createAccount(account: null | object): void
Parameters
- account: null | object
Returns void
- Defined in typescript-definitions.ts:2749

deleteAccount

deleteAccount(account: null | AccountAttributes): void
Parameters
- account: null | AccountAttributes
Returns void
- Defined in typescript-definitions.ts:2755
deleteAccount(account: null | object): void
Parameters
- account: null | object
Returns void
- Defined in typescript-definitions.ts:2761

deleteDevice

deleteDevice(accountId: null | string, deviceId: null | string): void
Delete a device with the given ID, associated with the given account ID.
Parameters
- accountId: null | string
- deviceId: null | string
Returns void
- Defined in typescript-definitions.ts:2769
deleteDevice(parameters: null | object): void
Parameters
- parameters: null | object
Returns void
- Defined in typescript-definitions.ts:2775

ensureNonDuplicateAccount

ensureNonDuplicateAccount(userName: null | string, primaryEmail: null | string): null | string
Parameters
- userName: null | string
- primaryEmail: null | string
Returns null | string
- Defined in typescript-definitions.ts:2782

getByEmail

getByEmail(email: null | string): null | object
Parameters
- email: null | string
Returns null | object
- Defined in typescript-definitions.ts:2788

getByPhone

getByPhone(phone: null | string): null | object
Parameters
- phone: null | string
Returns null | object
- Defined in typescript-definitions.ts:2794

getByUserName

getByUserName(userName: null | string): null | object
Parameters
- userName: null | string
Returns null | object
- Defined in typescript-definitions.ts:2800

getDevicesByUserName

getDevicesByUserName(userName: null | string): object[]
Parameters
- userName: null | string
Returns object[]
- Defined in typescript-definitions.ts:2806

initializeActivation

initializeActivation(accountAttributes: null | AccountAttributes, model: null | object): ScriptAccountManager$ScriptActivationResult
Parameters
- accountAttributes: null | AccountAttributes
- model: null | object
Returns ScriptAccountManager$ScriptActivationResult
- Defined in typescript-definitions.ts:2813
initializeActivation(accountAttributes: null | object, model: null | object): ScriptAccountManager$ScriptActivationResult
Parameters
- accountAttributes: null | object
- model: null | object
Returns ScriptAccountManager$ScriptActivationResult
- Defined in typescript-definitions.ts:2820

isSetPasswordAfterActivation

isSetPasswordAfterActivation(): boolean
Returns boolean
- Defined in typescript-definitions.ts:2822

listLinksByAccountId

listLinksByAccountId(accountId: string): any[]
Parameters
- accountId: string
Returns any[]
- Defined in typescript-definitions.ts:2828

listLinksBySubject

listLinksBySubject(subject: string): any[]
Parameters
- subject: string
Returns any[]
- Defined in typescript-definitions.ts:2834

resolveLink

resolveLink(foreignDomainName: string, foreignSubject: string): null | AccountAttributes
Parameters
- foreignDomainName: string
- foreignSubject: string
Returns null | AccountAttributes
- Defined in typescript-definitions.ts:2841

supportsRegistration

supportsRegistration(): boolean
Returns boolean
- Defined in typescript-definitions.ts:2843

updateAccount

updateAccount(account: null | AccountAttributes): boolean
Parameters
- account: null | AccountAttributes
Returns boolean
- Defined in typescript-definitions.ts:2849
updateAccount(account: null | object): boolean
Parameters
- account: null | object
Returns boolean
- Defined in typescript-definitions.ts:2855

Interface ScriptAccountManager

Hierarchy

Index

Methods

Methods

activateAccount

Parameters

token: null | string

Returns ScriptAccountManager$ScriptActivationResult

addDeviceForUser

Parameters

username: null | string

deviceId: null | string

deviceAlias: null | string

deviceNumber: null | string

formFactor: null | string

type: null | string

expiresAt: Instant

Returns void

Parameters

parameters: DeviceMap

Returns void

createAccount

Parameters

account: null | AccountAttributes

Returns void

Parameters

account: null | object

Returns void

deleteAccount

Parameters

account: null | AccountAttributes

Returns void

Parameters

account: null | object

Returns void

deleteDevice

Parameters

accountId: null | string

deviceId: null | string

Returns void

Parameters

parameters: null | object

Returns void

ensureNonDuplicateAccount

Parameters

userName: null | string

primaryEmail: null | string

Returns null | string

getByEmail

Parameters

email: null | string

Returns null | object

getByPhone

Parameters

phone: null | string

Returns null | object

getByUserName

Parameters

userName: null | string

Returns null | object

getDevicesByUserName

Parameters

userName: null | string

Returns object[]

initializeActivation

Parameters

accountAttributes: null | AccountAttributes

model: null | object

Returns ScriptAccountManager$ScriptActivationResult

Parameters

accountAttributes: null | object

model: null | object

Returns ScriptAccountManager$ScriptActivationResult

isSetPasswordAfterActivation

Returns boolean

listLinksByAccountId

Parameters

accountId: string

Returns any[]