Class RecipientSetMember

A member of a recipient set.

Hierarchy (View Summary)

Entity<RecipientSetMemberData>
- RecipientSetMember

Index

Constructors

Properties

Accessors

addedAt data emailAddress isDeleted

Methods

Constructors

constructor

new RecipientSetMember(
options: EntityOptions<RecipientSetMemberData>,
): RecipientSetMember
Parameters
- options: EntityOptions<RecipientSetMemberData>
  The client, path, backing data, and delete state.
Returns RecipientSetMember
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

addedAt

get addedAt(): string
When the member was added.

Returns string
- Defined in recipient-sets/entity.ts:125

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

emailAddress

get emailAddress(): string
The member's email address.

Returns string
- Defined in recipient-sets/entity.ts:120

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84