Class BotMetadata

Represents a BotMetadata.

Hierarchy

  • BotMetadata

Implements

Constructors

Properties

avatarMetadata?: null | IBotAvatarMetadata

BotMetadata avatarMetadata.

invokerJid: string

BotMetadata invokerJid.

personaId: string

BotMetadata personaId.

pluginMetadata?: null | IBotPluginMetadata

BotMetadata pluginMetadata.

suggestedPromptMetadata?: null | IBotSuggestedPromptMetadata

BotMetadata suggestedPromptMetadata.

Methods

  • Converts this BotMetadata to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a BotMetadata message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns BotMetadata

    BotMetadata

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes a BotMetadata message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns BotMetadata

    BotMetadata

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified BotMetadata message. Does not implicitly verify messages.

    Parameters

    • message: IBotMetadata

      BotMetadata message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified BotMetadata message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IBotMetadata

      BotMetadata message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Creates a BotMetadata message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns BotMetadata

    BotMetadata

  • Creates a plain object from a BotMetadata message. Also converts values to other types if specified.

    Parameters

    • message: BotMetadata

      BotMetadata

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a BotMetadata message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc