Class: CreateAccountParams
api.CreateAccountParams
Api parameters for creating a new Account to be used with API.createAccount.
Hierarchy
-
↳
CreateAccountParams
Constructors
constructor
• new CreateAccountParams(props?)
Parameters
| Name | Type |
|---|---|
props? |
Partial<CreateAccountParams> |
Overrides
Defined in
Properties
_propertySerializationOptions
• _propertySerializationOptions:
SerializationOptions[]
Inherited from
Serializable._propertySerializationOptions
Defined in
account
• account: Account
The Account object containing the relevant information
Defined in
auth
• auth: Auth
An Auth object container the verifier and authentication params required for subsequent authentication
Defined in
authToken
• authToken: string = ""
The authentication token obtained from API.completeAuthRequest.
Defined in
invite
• Optional invite: Object = undefined
The corresponding InviteID and OrgID if signup was initiated through an invite link.
optional
Type declaration
| Name | Type |
|---|---|
id |
string |
org |
string |
Defined in
verify
• verify: string = ""
The authentication token obtained from API.completeAuthRequest.
deprecated Use authToken property instead
Defined in
Accessors
kind
• get kind(): string
A string representing the objects "type", useful for segmenting storage, among other things. Defaults to the lowercase class name, but can be overwritten by subclasses
Returns
string
Inherited from
Serializable.kind
Defined in
Methods
_fromRaw
▸ Protected _fromRaw(raw): void
Restore values from a raw object. The default implementation simply copies over all iterable properties from the base object. Overwrite this method for properties that require special treatment
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
void
Inherited from
Defined in
_toRaw
▸ Protected _toRaw(version): any
Transform this object into a raw javascript object used for serialization. The default implementation simply copies all iterable properties not included in the [[exlude]] array and calls toRaw on any properties that are themselfes instances of Serializable. This method should be overwritten by subclasses if certain properties require special treatment.
Parameters
| Name | Type |
|---|---|
version |
undefined | string |
Returns
any
Inherited from
Defined in
clone
▸ clone(): CreateAccountParams
Creates a deep clone of the object
Returns
Inherited from
Defined in
fromBytes
▸ fromBytes(bytes): CreateAccountParams
Deserializes the object from a byte array
Parameters
| Name | Type |
|---|---|
bytes |
Uint8Array |
Returns
Inherited from
Defined in
fromJSON
▸ fromJSON(json): CreateAccountParams
Deserializes the object from a JSON string
Parameters
| Name | Type |
|---|---|
json |
string |
Returns
Inherited from
Defined in
fromRaw
▸ fromRaw(raw): CreateAccountParams
Restores propertiers from a raw object of the same form generated by
toRaw. The base implementation blindly
copies over values from the raw object via Object.assign so subclasses should
explictly process any propertyies that need special treatment.
Also takes are of validation and "upgrading" in case the raw object has an old version. Use the protected _fromRaw method to implement subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
Inherited from
Defined in
toBytes
▸ toBytes(): Uint8Array
Returns a serialization of the object in form of a byte array
Returns
Uint8Array
Inherited from
Defined in
toJSON
▸ toJSON(): string
Returns a JSON serialization of the object
Returns
string
Inherited from
Defined in
toRaw
▸ toRaw(version?): any
Creates a raw javascript object representation of the class, which can be used for storage or data transmission. Also handles "downgrading" to previous versions. Use _toRaw for subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
version? |
string |
Returns
any
Inherited from
Defined in
validate
▸ validate(): boolean
This is called during deserialization and should verify that all properties have been populated with values of the correct type. Subclasses should implement this method based on their class structure.
Returns
boolean