Class TopicMessageQuery

constructor

• new TopicMessageQuery(
      props?: {
          completionHandler?: () => void;
          endTime?: Timestamp;
          errorHandler?: (message: null | TopicMessage, error: Error) => void;
          limit?: number | Long;
          retryHandler?: (error: null | Error | MirrorError) => boolean;
          startTime?: Timestamp;
          topicId?: string | TopicId;
      },
  ): TopicMessageQuery

  Parameters

  • props: {
        completionHandler?: () => void;
        endTime?: Timestamp;
        errorHandler?: (message: null | TopicMessage, error: Error) => void;
        limit?: number | Long;
        retryHandler?: (error: null | Error | MirrorError) => boolean;
        startTime?: Timestamp;
        topicId?: string | TopicId;
    } = {}

  Returns TopicMessageQuery

_listener

_maxAttempts

endTime

• get endTime(): null | Timestamp

  Returns null | Timestamp

limit

• get limit(): null | Long

  Returns null | Long

startTime

• get startTime(): null | Timestamp

  Returns null | Timestamp

topicId

• get topicId(): null | TopicId

  Returns null | TopicId

requireNotSubscribed

• requireNotSubscribed(): void

  Returns void

setCompletionHandler

• setCompletionHandler(completionHandler: () => void): TopicMessageQuery

  Parameters

  • completionHandler: () => void

  Returns TopicMessageQuery

setEndTime

• setEndTime(endTime: number | Date | Timestamp): TopicMessageQuery

  Parameters

  • endTime: number | Date | Timestamp

  Returns TopicMessageQuery

setErrorHandler

• setErrorHandler(
      errorHandler: (message: null | TopicMessage, error: Error) => void,
  ): TopicMessageQuery

  Parameters

  • errorHandler: (message: null | TopicMessage, error: Error) => void

  Returns TopicMessageQuery

setLimit

• setLimit(limit: number | Long): TopicMessageQuery

  Parameters

  • limit: number | Long

  Returns TopicMessageQuery

setMaxAttempts

• setMaxAttempts(attempts: number): TopicMessageQuery

  Parameters

  • attempts: number

  Returns TopicMessageQuery

setMaxBackoff

• setMaxBackoff(backoff: number): TopicMessageQuery

  Parameters

  • backoff: number

  Returns TopicMessageQuery

setStartTime

• setStartTime(startTime: number | Date | Timestamp): TopicMessageQuery

  Sets the consensus time to start receiving messages from.

  If not set, the mirror node starts at its current time. If the subscription fails before the first message arrives, the retry starts from the time subscribe() was called, read from the client clock.

  Parameters

  • startTime: number | Date | Timestamp

  Returns TopicMessageQuery

setTopicId

• setTopicId(topicId: string | TopicId): TopicMessageQuery

  Parameters

  • topicId: string | TopicId

  Returns TopicMessageQuery

subscribe

• subscribe(
      client: Client<Channel, MirrorChannel>,
      errorHandler: null | ((message: null | TopicMessage, error: Error) => void),
      listener: (message: TopicMessage) => void,
  ): SubscriptionHandle

  Parameters

  • client: Client<Channel, MirrorChannel>
  • errorHandler: null | ((message: null | TopicMessage, error: Error) => void)
  • listener: (message: TopicMessage) => void

  Returns SubscriptionHandle