Interface MessageTokenBuilderObject

Provides methods for adding various types of tokens to a message.

interface MessageTokenBuilderObject {
    Add: ((obj: any) => boolean);
    AddAccount: (() => boolean);
    AddBudget: ((customerId: number, amount: number) => boolean);
    AddCommon: (() => boolean);
    AddCustomer: ((customerId: number) => boolean);
    AddHotFolder: ((hotFolderId: number) => boolean);
    AddOrder: ((orderId: number) => boolean);
    AddOrderProduct: ((opvId: number) => boolean);
    AddProduct: ((productId: number) => boolean);
}

Properties

Add AddAccount AddBudget AddCommon AddCustomer AddHotFolder AddOrder AddOrderProduct AddProduct

Properties

Add

Add: ((obj: any) => boolean)

Adds a generic object as a token.

Type declaration

    • (obj): boolean

    • Parameters

      • obj: any

        The object to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

AddAccount

AddAccount: (() => boolean)

Adds an account token.

Type declaration

    • (): boolean

    • Returns boolean

      A boolean indicating success or failure of adding the token.

AddBudget

AddBudget: ((customerId: number, amount: number) => boolean)

Adds a budget amount for a customer as a token.

Type declaration

    • (customerId, amount): boolean

    • Parameters

      • customerId: number

        The ID of the customer whose budget to add as a token.

      • amount: number

        The budget amount to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

AddCommon

AddCommon: (() => boolean)

Adds common tokens.

Type declaration

    • (): boolean

    • Returns boolean

      A boolean indicating success or failure of adding the tokens.

AddCustomer

AddCustomer: ((customerId: number) => boolean)

Adds a customer ID token.

Type declaration

    • (customerId): boolean

    • Parameters

      • customerId: number

        The ID of the customer to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

AddHotFolder

AddHotFolder: ((hotFolderId: number) => boolean)

Adds a hot folder ID token.

Type declaration

    • (hotFolderId): boolean

    • Parameters

      • hotFolderId: number

        The ID of the hot folder to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

AddOrder

AddOrder: ((orderId: number) => boolean)

Adds an order ID token.

Type declaration

    • (orderId): boolean

    • Parameters

      • orderId: number

        The ID of the order to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

AddOrderProduct

AddOrderProduct: ((opvId: number) => boolean)

Adds an order product variant ID token.

Type declaration

    • (opvId): boolean

    • Parameters

      • opvId: number

        The ID of the order product variant to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

AddProduct

AddProduct: ((productId: number) => boolean)

Adds a product ID token.

Type declaration

    • (productId): boolean

    • Parameters

      • productId: number

        The ID of the product to add as a token.

      Returns boolean

      A boolean indicating success or failure of adding the token.

Settings

Member Visibility

On This Page

Properties