Class PendingApproval

Hierarchy

PendingApproval

Index

Constructors

constructor

Methods

Constructors

constructor

new PendingApproval(bitgo: BitGo, baseCoin: BaseCoin, pendingApprovalData: PendingApprovalData, wallet?: Wallet): PendingApproval

- Defined in src/v2/pendingApproval.ts:70
Parameters
- bitgo: BitGo
- baseCoin: BaseCoin
- pendingApprovalData: PendingApprovalData
- Optional wallet: Wallet
Returns PendingApproval

Methods

approvalsRequired

approvalsRequired(): number

- Defined in src/v2/pendingApproval.ts:152
Get the number of approvals that are required for this PendingApproval to be approved. Defaults to 1 if approvalsRequired doesn't exist on the object

Returns number

approve

approve(params?: ApproveOptions, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/pendingApproval.ts:213
Sets this PendingApproval to an approved state

Parameters
- Default value params: ApproveOptions = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

cancel

cancel(params?: __type, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/pendingApproval.ts:326
Alias for PendingApproval.reject()

deprecated

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

creator

creator(): string

- Defined in src/v2/pendingApproval.ts:126
Get the id of the user that performed the action resulting in this PendingApproval

Returns string

enterpriseId

enterpriseId(): string | undefined

- Defined in src/v2/pendingApproval.ts:112
Get the enterprise ID that is associated with this PendingApproval

Returns string | undefined

get

get(params?: __type, callback?: NodeCallback<PendingApproval>): Bluebird<PendingApproval>

- Defined in src/v2/pendingApproval.ts:171
Refetches this PendingApproval from the server and returns it.

Note that this mutates the PendingApproval object in place.

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<PendingApproval>
Returns Bluebird<PendingApproval>

id

id(): string

- Defined in src/v2/pendingApproval.ts:82
Get the id for this PendingApproval

Returns string

info

info(): PendingApprovalInfo

- Defined in src/v2/pendingApproval.ts:144
Get information about this PendingApproval

Returns PendingApprovalInfo

ownerType

ownerType(): OwnerType

- Defined in src/v2/pendingApproval.ts:92
Get the owner type (wallet or enterprise) Pending approvals can be approved or modified by different scopes (depending on how they were created) If a pending approval is owned by a wallet, then it can be approved by administrators of the wallet If a pending approval is owned by an enterprise, then it can be approved by administrators of the enterprise

Returns OwnerType

recreateAndSignTransaction

recreateAndSignTransaction(params?: any, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/pendingApproval.ts:335
Recreate a transaction for a pending approval to respond to updated network conditions

Parameters
- Default value params: any = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

reject

reject(params?: __type, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/pendingApproval.ts:311
Sets this PendingApproval to a rejected state

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

state

state(): State

- Defined in src/v2/pendingApproval.ts:119
Get the state of this PendingApproval

Returns State

type

type(): Type

- Defined in src/v2/pendingApproval.ts:133
Get the type of the pending approval (what it approves)

Returns Type

url

url(extra?: string): string

- Defined in src/v2/pendingApproval.ts:160
Generate a url for this PendingApproval for making requests to the server.

Parameters
- Default value extra: string = ""
Returns string

walletId

walletId(): string | undefined

- Defined in src/v2/pendingApproval.ts:105
Get the id of the wallet which is associated with this PendingApproval

Returns string | undefined

Generated using TypeDoc