Class: Invitation
Represents an Invitation.
Implements
Constructors
constructor
• new Invitation(properties?): Invitation
Constructs a new Invitation.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInvitation | Properties to set |
Returns
Properties
createdTime
• Optional createdTime: null | ITimestamp
The date and time when the user was created
Implementation of
expiredTime
• Optional expiredTime: null | ITimestamp
The date and time when the invitation expires or has expired
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Invitation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Invitation
Creates a new Invitation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInvitation | Properties to set |
Returns
Invitation instance
decode
▸ decode(reader, length?): Invitation
Decodes an Invitation message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Invitation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Invitation
Decodes an Invitation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Invitation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Invitation message. Does not implicitly temporal.api.cloud.identity.v1.Invitation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IInvitation | Invitation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Invitation message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.Invitation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IInvitation | Invitation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Invitation
Creates an Invitation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Invitation
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Invitation
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Invitation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Invitation | Invitation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object