Class: User

identity.v1.User

Represents a User.

Implements

• IUser

Constructors

constructor

• new User(properties?): User

Constructs a new User.

Parameters

Name	Type	Description
properties?	IUser	Properties to set

Returns

User

Properties

asyncOperationId

• asyncOperationId: string

The id of the async operation that is creating/updating/deleting the user, if any

Implementation of

IUser.asyncOperationId

---

createdTime

• Optional createdTime: null | ITimestamp

The date and time when the user was created

Implementation of

IUser.createdTime

---

id

• id: string

The id of the user

Implementation of

IUser.id

---

invitation

• Optional invitation: null | IInvitation

The details of the open invitation sent to the user, if any

Implementation of

IUser.invitation

---

lastModifiedTime

• Optional lastModifiedTime: null | ITimestamp

The date and time when the user was last modified Will not be set if the user has never been modified

Implementation of

IUser.lastModifiedTime

---

resourceVersion

• resourceVersion: string

The current version of the user specification The next update operation will have to include this version

Implementation of

IUser.resourceVersion

---

spec

• Optional spec: null | IUserSpec

The user specification

Implementation of

IUser.spec

---

state

• state: string

The current state of the user

Implementation of

IUser.state

Methods

toJSON

▸ toJSON(): Object

Converts this User to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): User

Creates a new User instance using the specified properties.

Parameters

Name	Type	Description
properties?	IUser	Properties to set

Returns

User

User instance

---

decode

▸ decode(reader, length?): User

Decodes a User 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

User

User

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): User

Decodes a User message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

User

User

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 User message. Does not implicitly temporal.api.cloud.identity.v1.User.verify|verify messages.

Parameters

Name	Type	Description
message	IUser	User message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified User message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.User.verify|verify messages.

Parameters

Name	Type	Description
message	IUser	User message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): User

Creates a User message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

User

User

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for User

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 a User message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	User	User
options?	IConversionOptions	Conversion options

Returns

Object

Plain object