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 getById 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:3399

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:3412
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:3419

createAccount

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

deleteAccount

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

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:3451
deleteDevice(parameters: null | object): void
Parameters
- parameters: null | object
Returns void
- Defined in typescript-definitions.ts:3457

ensureNonDuplicateAccount

ensureNonDuplicateAccount(userName: null | string, primaryEmail: null | string): null | string
Given (optionally) an email address and a username, determine (using either or neither of those) whether the user account exists or not. Returns null if the account is unique, or an error message otherwise.
Parameters
- userName: null | string
- primaryEmail: null | string
Returns null | string
- Defined in typescript-definitions.ts:3465

getByEmail

getByEmail(email: null | string): null | object
Get a user account by email address.
Parameters
- email: null | string
Returns null | object
- Defined in typescript-definitions.ts:3472

getById

getById(accountId: null | string): null | object
Get a user account by ID.
Parameters
- accountId: null | string
Returns null | object
- Defined in typescript-definitions.ts:3479

getByPhone

getByPhone(phone: null | string): null | object
Get a user account by phone number.
Parameters
- phone: null | string
Returns null | object
- Defined in typescript-definitions.ts:3486

getByUserName

getByUserName(userName: null | string): null | object
Get a user account by userName.
Parameters
- userName: null | string
Returns null | object
- Defined in typescript-definitions.ts:3493

getDevicesByUserName

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

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:3506
initializeActivation(accountAttributes: null | object, model: null | object): ScriptAccountManager$ScriptActivationResult
Parameters
- accountAttributes: null | object
- model: null | object
Returns ScriptAccountManager$ScriptActivationResult
- Defined in typescript-definitions.ts:3513

isSetPasswordAfterActivation

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

listLinksByAccountId

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

listLinksBySubject

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

resolveLink

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

supportsRegistration

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

updateAccount

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

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

getById

Parameters

accountId: 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