Class BotMetadata

constructor

• new BotMetadata(properties?): BotMetadata

• Constructs a new BotMetadata.

  Parameters

  • Optional properties: IBotMetadata

    Properties to set

  Returns BotMetadata

Optional avatarMetadata

Optional botLinkedAccountsMetadata

Optional botMetricsMetadata

Optional capabilityMetadata

Optional imagineMetadata

Optional invokerJid

Optional memoryMetadata

Optional memuMetadata

Optional messageDisclaimerText

Optional modelMetadata

Optional personaId

Optional pluginMetadata

Optional progressIndicatorMetadata

Optional reminderMetadata

Optional renderingMetadata

Optional sessionMetadata

Optional suggestedPromptMetadata

Optional timezone

toJSON

• toJSON(): {
      [k: string]: any;
  }

• Converts this BotMetadata to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): BotMetadata

• Creates a new BotMetadata instance using the specified properties.

  Parameters

  • Optional properties: IBotMetadata

    Properties to set

  Returns BotMetadata

  BotMetadata instance

Static decode

• decode(reader, length?): BotMetadata

• 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

Static decodeDelimited

• decodeDelimited(reader): BotMetadata

• 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

Static encode

• encode(message, writer?): Writer

• 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

Static encodeDelimited

• encodeDelimited(message, 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

Static fromObject

• fromObject(object): BotMetadata

• 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

Static getTypeUrl

• getTypeUrl(typeUrlPrefix?): string

• Gets the default type url for BotMetadata

  Parameters

  • Optional typeUrlPrefix: string

    your custom typeUrlPrefix(default "type.googleapis.com")

  Returns string

  The default type url

Static toObject

• toObject(message, options?): {
      [k: string]: any;
  }

• 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

Static verify

• verify(message): null | string

• 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