Class BotPluginMetadata

constructor

• new BotPluginMetadata(properties?): BotPluginMetadata

• Constructs a new BotPluginMetadata.

  Parameters

  • Optional properties: IBotPluginMetadata

    Properties to set

  Returns BotPluginMetadata

Optional deprecatedField

Optional expectedLinksCount

Optional faviconCdnUrl

Optional parentPluginMessageKey

Optional parentPluginType

Optional pluginType

Optional profilePhotoCdnUrl

Optional provider

Optional referenceIndex

Optional searchProviderUrl

Optional searchQuery

Optional thumbnailCdnUrl

toJSON

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

• Converts this BotPluginMetadata to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): BotPluginMetadata

• Creates a new BotPluginMetadata instance using the specified properties.

  Parameters

  • Optional properties: IBotPluginMetadata

    Properties to set

  Returns BotPluginMetadata

  BotPluginMetadata instance

Static decode

• decode(reader, length?): BotPluginMetadata

• Decodes a BotPluginMetadata 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 BotPluginMetadata

  BotPluginMetadata

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static decodeDelimited

• decodeDelimited(reader): BotPluginMetadata

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

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns BotPluginMetadata

  BotPluginMetadata

  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 BotPluginMetadata message. Does not implicitly verify messages.

  Parameters

  • message: IBotPluginMetadata

    BotPluginMetadata 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 BotPluginMetadata message, length delimited. Does not implicitly verify messages.

  Parameters

  • message: IBotPluginMetadata

    BotPluginMetadata message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static fromObject

• fromObject(object): BotPluginMetadata

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

  Parameters

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

    Plain object

    • [k: string]: any

  Returns BotPluginMetadata

  BotPluginMetadata

Static getTypeUrl

• getTypeUrl(typeUrlPrefix?): string

• Gets the default type url for BotPluginMetadata

  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 BotPluginMetadata message. Also converts values to other types if specified.

  Parameters

  • message: BotPluginMetadata

    BotPluginMetadata

  • Optional options: IConversionOptions

    Conversion options

  Returns {
      [k: string]: any;
  }

  Plain object

  • [k: string]: any

Static verify

• verify(message): null | string

• Verifies a BotPluginMetadata 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