Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessageApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected api

api: DCoreApi

Methods

createMessageOperation

  • Create message operation, send messages to multiple receivers

    Parameters

    • credentials: Credentials

      sender account credentials

    • messages: Array<[ChainObject, string]>

      a list of pairs of receiver account id and message

    • Optional fee: Fee

      fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough

    Returns Observable<SendMessageOperation>

    send message operation

createMessageOperationUnencrypted

  • Create message operation, send messages to multiple receivers, unencrypted

    Parameters

    • credentials: Credentials

      sender account credentials

    • messages: Array<[ChainObject, string]>

      a list of pairs of receiver account id and message

    • Optional fee: Fee

      fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough

    Returns Observable<SendMessageOperation>

    send message operation

findAll

  • Find all messages

    Parameters

    • Optional sender: ChainObject

      filter by sender account id

    • Optional receiver: ChainObject

      filter by receiver account id

    • Default value maxCount: number = 1000

      max items to return

    Returns Observable<Message[]>

    list of messages

findAllDecrypted

  • Find all messages and decrypt

    Parameters

    • credentials: Credentials

      account credentials used for decryption, must be either sender's or receiver's

    • Optional sender: ChainObject

      filter by sender account id

    • Optional receiver: ChainObject

      filter by receiver account id

    • Default value maxCount: number = 1000

      max items to return

    Returns Observable<Message[]>

    list of messages

findAllDecryptedForReceiver

  • findAllDecryptedForReceiver(credentials: Credentials, maxCount?: number): Observable<Message[]>

  • Find all messages for receiver and decrypt

    Parameters

    • credentials: Credentials

      receiver account credentials with decryption keys

    • Default value maxCount: number = 1000

      max items to return

    Returns Observable<Message[]>

    list of messages

findAllDecryptedForSender

  • findAllDecryptedForSender(credentials: Credentials, maxCount?: number): Observable<Message[]>

  • Find all messages for sender and decrypt

    Parameters

    • credentials: Credentials

      sender account credentials with decryption keys

    • Default value maxCount: number = 1000

      max items to return

    Returns Observable<Message[]>

    list of messages

findAllOperations

  • Find all message operations

    Parameters

    • Optional sender: ChainObject

      filter by sender account id

    • Optional receiver: ChainObject

      filter by receiver account id

    • Default value maxCount: number = 1000

      max items to return

    Returns Observable<MessageResponse[]>

    list of message operation responses

get

getAll

Protected request

send

  • Send messages to multiple receivers

    Parameters

    • credentials: Credentials

      sender account credentials

    • messages: Array<[ChainObject, string]>

      a list of pairs of receiver account id and message

    • Optional fee: Fee

      fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough

    Returns Observable<TransactionConfirmation>

    a transaction confirmation

sendUnencrypted

  • Send unencrypted messages to multiple receivers

    Parameters

    • credentials: Credentials

      sender account credentials

    • messages: Array<[ChainObject, string]>

      a list of pairs of receiver account id and message

    • Optional fee: Fee

      fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough

    Returns Observable<TransactionConfirmation>

    a transaction confirmation

Generated using TypeDoc