Class Conversation

constructor

• new Conversation(
      participant: string,
      participantPublicKey?: Uint8Array<ArrayBufferLike>,
      messages?: Message[],
      lastFetchedRound?: number,
  ): Conversation

  Creates a new Conversation

  Parameters

  • participant: string

    Algorand address of the other party

  • OptionalparticipantPublicKey: Uint8Array<ArrayBufferLike>

    X25519 encryption public key (if known)

  • messages: Message[] = []

    Initial messages

  • OptionallastFetchedRound: number

    Last blockchain round that was fetched

  Returns Conversation

OptionallastFetchedRound

Readonlyparticipant

OptionalparticipantPublicKey

firstMessage

• get firstMessage(): Message | undefined

  Gets the first message in the conversation

  Returns Message | undefined

highestRound

• get highestRound(): number

  Gets the highest confirmed round across all messages

  Returns number

isEmpty

• get isEmpty(): boolean

  Checks if the conversation has no messages

  Returns boolean

lastMessage

• get lastMessage(): Message | undefined

  Gets the most recent message

  Returns Message | undefined

lastReceived

• get lastReceived(): Message | undefined

  Gets the most recent received message

  Returns Message | undefined

lastSent

• get lastSent(): Message | undefined

  Gets the most recent sent message

  Returns Message | undefined

messageCount

• get messageCount(): number

  Gets the total number of messages

  Returns number

messages

• get messages(): Message[]

  Gets all messages in chronological order

  Returns Message[]

receivedCount

• get receivedCount(): number

  Gets the number of received messages

  Returns number

sentCount

• get sentCount(): number

  Gets the number of sent messages

  Returns number

append

• append(message: Message): boolean

  Appends a message to the conversation

  If the message already exists (by ID), it is ignored. Messages are kept sorted by timestamp.

  Parameters

  • message: Message

    Message to append

  Returns boolean

  true if message was added, false if it already existed

clone

• clone(): Conversation

  Creates a shallow copy of the conversation

  Returns Conversation

getMessage

• getMessage(id: string): Message | undefined

  Gets a message by ID

  Parameters

  • id: string

    Transaction ID of the message

  Returns Message | undefined

hasMessage

• hasMessage(id: string): boolean

  Checks if a message exists

  Parameters

  • id: string

    Transaction ID to check

  Returns boolean

merge

• merge(messages: Message[]): number

  Merges multiple messages into the conversation

  Duplicates are ignored. Messages are sorted after merge.

  Parameters

  • messages: Message[]

    Messages to merge

  Returns number

  Number of new messages added

messagesAfterRound

• messagesAfterRound(round: number): Message[]

  Gets messages after a specific round

  Parameters

  • round: number

    Minimum round (exclusive)

  Returns Message[]

messagesInDirection

• messagesInDirection(direction: MessageDirection): Message[]

  Gets messages in a direction

  Parameters

  • direction: MessageDirection

    'sent' or 'received'

  Returns Message[]

searchMessages

• searchMessages(query: string): Message[]

  Searches messages by content

  Parameters

  • query: string

    Search string (case-insensitive)

  Returns Message[]

setLastFetchedRound

• setLastFetchedRound(round: number): void

  Updates the last fetched round

  Parameters

  • round: number

    The round number

  Returns void

setParticipantPublicKey

• setParticipantPublicKey(publicKey: Uint8Array): void

  Updates the participant's public key

  Parameters

  • publicKey: Uint8Array

    The new public key

  Returns void

toJSON

• toJSON(): {
      lastFetchedRound?: number;
      messages: Message[];
      participant: string;
      participantPublicKey?: string;
  }

  Converts to a plain object for serialization

  Returns {
      lastFetchedRound?: number;
      messages: Message[];
      participant: string;
      participantPublicKey?: string;
  }

StaticfromJSON

• fromJSON(
      data: {
          lastFetchedRound?: number;
          messages: (Message | { timestamp: string; [key: string]: unknown })[];
          participant: string;
          participantPublicKey?: string;
      },
  ): Conversation

  Creates a Conversation from a plain object

  Parameters

  • data: {
        lastFetchedRound?: number;
        messages: (Message | { timestamp: string; [key: string]: unknown })[];
        participant: string;
        participantPublicKey?: string;
    }

  Returns Conversation