.Net SDK
Tokenio.AccessTokenBuilder Class Reference

Helps building an access token payload. More...

Public Member Functions

AccessTokenBuilder ForAllAddresses ()
 Grants access to all addresses. More...
 
AccessTokenBuilder ForAddress (string addressId)
 Grants access to a given address id. More...
 
AccessTokenBuilder ForAllAccounts ()
 Grants access to all accounts. More...
 
AccessTokenBuilder ForAllAccountsAtBank (string bankId)
 Grants access to all accounts at the given bank. More...
 
AccessTokenBuilder ForAccount (string accountId)
 Grants access to a given account id. More...
 
AccessTokenBuilder ForAllTransactions ()
 Grants access to all transactions. More...
 
AccessTokenBuilder ForAllTransactionsAtBank (string bankId)
 Grants access to transactions for all accounts at a given bank. More...
 
AccessTokenBuilder ForAccountTransactions (string accountId)
 Grants access to transactions of a given account. More...
 
AccessTokenBuilder ForAllBalances ()
 Grants access to all balances. More...
 
AccessTokenBuilder ForAllBalancesAtBank (string bankId)
 Grants access to balances for all accounts at the given bank. More...
 
AccessTokenBuilder ForAccountBalances (string accountId)
 Grants access to balances of a given account. More...
 
AccessTokenBuilder ForAllTransferDestinations ()
 Grants access to all transfer destinations. More...
 
AccessTokenBuilder ForAllTransferDestinationsAtBank (string bankId)
 Grants access to all transfer destinations at the given bank. More...
 
AccessTokenBuilder ForTransferDestination (string accountId)
 Grants access to a transfer destinations for the given account. More...
 
AccessTokenBuilder ForAll ()
 Grants access to ALL resources (aka wildcard permissions). More...
 
AccessTokenBuilder From (string memberId)
 Sets "from" field on the payload. More...
 
AccessTokenBuilder To (Alias redeemerAlias)
 Sets "to" field on the payload. More...
 
AccessTokenBuilder To (string redeemerMemberId)
 Sets "to" field on the payload. More...
 
AccessTokenBuilder ActingAs (ActingAs actingAs)
 Sets "acting as" field on the payload. More...
 
TokenPayload Build ()
 Builds the TokenPayload with all specified settings. More...
 

Static Public Member Functions

static AccessTokenBuilder Create (Alias redeemerAlias)
 Creates an instance of AccessTokenBuilder More...
 
static AccessTokenBuilder Create (string redeemerMemberId)
 Creates an instance of AccessTokenBuilder. More...
 
static AccessTokenBuilder FromPayload (TokenPayload payload)
 Creates an instance of AccessTokenBuilder More...
 

Detailed Description

Helps building an access token payload.

Member Function Documentation

◆ ActingAs()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ActingAs ( ActingAs  actingAs)
inline

Sets "acting as" field on the payload.

Parameters
actingAsentity the redeemer is acting on behalf of
Returns
AccessTokenBuilder

◆ Build()

TokenPayload Tokenio.AccessTokenBuilder.Build ( )
inline

Builds the TokenPayload with all specified settings.

Returns
an instance of TokenPayload
Exceptions
ArgumentException

◆ Create() [1/2]

static AccessTokenBuilder Tokenio.AccessTokenBuilder.Create ( Alias  redeemerAlias)
inlinestatic

Creates an instance of AccessTokenBuilder

Parameters
redeemerAliasthe redeemer alias
Returns
an instance of AccessTokenBuilder

◆ Create() [2/2]

static AccessTokenBuilder Tokenio.AccessTokenBuilder.Create ( string  redeemerMemberId)
inlinestatic

Creates an instance of AccessTokenBuilder.

Parameters
redeemerMemberIdthe redeemer member id
Returns

◆ ForAccount()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAccount ( string  accountId)
inline

Grants access to a given account id.

Returns
AccessTokenBuilder

◆ ForAccountBalances()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAccountBalances ( string  accountId)
inline

Grants access to balances of a given account.

Returns
AccessTokenBuilder

◆ ForAccountTransactions()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAccountTransactions ( string  accountId)
inline

Grants access to transactions of a given account.

Returns
AccessTokenBuilder

◆ ForAddress()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAddress ( string  addressId)
inline

Grants access to a given address id.

Returns
AccessTokenBuilder

◆ ForAll()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAll ( )
inline

Grants access to ALL resources (aka wildcard permissions).

Returns
AccessTokenBuilder

◆ ForAllAccounts()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllAccounts ( )
inline

Grants access to all accounts.

Returns
AccessTokenBuilder

◆ ForAllAccountsAtBank()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllAccountsAtBank ( string  bankId)
inline

Grants access to all accounts at the given bank.

Returns
AccessTokenBuilder

◆ ForAllAddresses()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllAddresses ( )
inline

Grants access to all addresses.

Returns
AccessTokenBuilder

◆ ForAllBalances()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllBalances ( )
inline

Grants access to all balances.

Returns
AccessTokenBuilder

◆ ForAllBalancesAtBank()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllBalancesAtBank ( string  bankId)
inline

Grants access to balances for all accounts at the given bank.

Returns
AccessTokenBuilder

◆ ForAllTransactions()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllTransactions ( )
inline

Grants access to all transactions.

Returns
AccessTokenBuilder

◆ ForAllTransactionsAtBank()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllTransactionsAtBank ( string  bankId)
inline

Grants access to transactions for all accounts at a given bank.

Returns
AccessTokenBuilder

◆ ForAllTransferDestinations()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllTransferDestinations ( )
inline

Grants access to all transfer destinations.

Returns
AccessTokenBuilder

◆ ForAllTransferDestinationsAtBank()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForAllTransferDestinationsAtBank ( string  bankId)
inline

Grants access to all transfer destinations at the given bank.

Returns
AccessTokenBuilder

◆ ForTransferDestination()

AccessTokenBuilder Tokenio.AccessTokenBuilder.ForTransferDestination ( string  accountId)
inline

Grants access to a transfer destinations for the given account.

Returns
AccessTokenBuilder

◆ From()

AccessTokenBuilder Tokenio.AccessTokenBuilder.From ( string  memberId)
inline

Sets "from" field on the payload.

Parameters
memberIdthe token member ID to set
Returns
AccessTokenBuilder

◆ FromPayload()

static AccessTokenBuilder Tokenio.AccessTokenBuilder.FromPayload ( TokenPayload  payload)
inlinestatic

Creates an instance of AccessTokenBuilder

Parameters
payloadthe payload to initialize from
Returns
an instance of AccessTokenBuilder

◆ To() [1/2]

AccessTokenBuilder Tokenio.AccessTokenBuilder.To ( Alias  redeemerAlias)
inline

Sets "to" field on the payload.

Parameters
redeemerAliasthe redeemer's alias
Returns
AccessTokenBuilder

◆ To() [2/2]

AccessTokenBuilder Tokenio.AccessTokenBuilder.To ( string  redeemerMemberId)
inline

Sets "to" field on the payload.

Parameters
redeemerMemberIdthe redeemer's member id
Returns
AccessTokenBuilder

The documentation for this class was generated from the following file: