Class Identity

Hierarchy

Identity

Implements

Model

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Identity(client: HttpClient, pod: Readonly<PODModel & { tokenVerifiers: IdentityTokenVerifier[] }>): Identity

- Defined in src/identity.ts:44
Parameters
- client: HttpClient
- pod: Readonly<PODModel & { tokenVerifiers: IdentityTokenVerifier[] }>
Returns Identity

Properties

Private #client

#client: HttpClient

Readonly createdAt

createdAt: Date

The number of seconds since the Unix epoch when this model was created

Readonly id

The model's unique ID.

Readonly tokenVerifiers

tokenVerifiers: IdentityTokenVerifier[]

Methods

delete

delete(): Promise<void>

- Defined in src/identity.ts:56
Returns Promise<void>

getGrantedPermission

getGrantedPermission(id: PermissionId): Promise<Permission>

- Defined in src/identity.ts:84
Gets a granted permission by id. Useful for checking if a permission has been granted.

Parameters
- id: PermissionId
Returns Promise<Permission>

getTokenBalance

getTokenBalance(token: TokenId): Promise<TokenBalance>

- Defined in src/identity.ts:98
Parameters
- token: TokenId
Returns Promise<TokenBalance>

grantPermission

grantPermission(id: PermissionId): Promise<GrantedPermission>

- Defined in src/identity.ts:79
Parameters
- id: PermissionId
Returns Promise<GrantedPermission>

linkEthAddr

linkEthAddr(prover: EthAddrProver): Promise<LinkedEthAddr>

- Defined in src/identity.ts:60
Parameters
- prover: EthAddrProver
Returns Promise<LinkedEthAddr>

listGrantedPermissions

listGrantedPermissions(filter?: Partial<{ app: AppId }> & Partial<{ pageSize: number; pageToken: string }>): Promise<Page<Permission>>

- Defined in src/identity.ts:73
Fetches permissions to which this identity has agreed.

Parameters
- Optional filter: Partial<{ app: AppId }> & Partial<{ pageSize: number; pageToken: string }>
Returns Promise<Page<Permission>>

listLinkedEthAddrs

listLinkedEthAddrs(filter?: Partial<{ pageSize: number; pageToken: string }>): Promise<Page<LinkedEthAddr>>

- Defined in src/identity.ts:68
Parameters
- Optional filter: Partial<{ pageSize: number; pageToken: string }>
Returns Promise<Page<LinkedEthAddr>>

listTokens

listTokens(filter?: Partial<{ pageSize: number; pageToken: string }>): Promise<Page<TokenBalance>>

- Defined in src/identity.ts:94
Parameters
- Optional filter: Partial<{ pageSize: number; pageToken: string }>
Returns Promise<Page<TokenBalance>>

revokePermission

revokePermission(id: PermissionId): Promise<void>

- Defined in src/identity.ts:88
Parameters
- id: PermissionId
Returns Promise<void>

unlinkEthAddr

unlinkEthAddr(ethAddr: string): Promise<void>

- Defined in src/identity.ts:64
Parameters
- ethAddr: string
Returns Promise<void>

update

update(params: IdentityUpdateParams): Promise<Identity>

- Defined in src/identity.ts:51
Parameters
- params: IdentityUpdateParams
Returns Promise<Identity>

Generated using TypeDoc