ExMicrosoftBot.Models.Entity (ex_microsoftbot v3.0.0)

Microsoft bot entity structure.

Depending on the type value, different fields in the struct will be used. See defined types for more info.

Link to this section Summary

Types

Known types thus far: "clientInfo" & "mention".

t()

Link to this section Types

Link to this type

entity_type()

Specs

entity_type() :: String.t()

Known types thus far: "clientInfo" & "mention".

Specs

t() ::
  %ExMicrosoftBot.Models.Entity{
    country: term(),
    locale: term(),
    mentioned: term(),
    name: String.t() | nil,
    platform: term(),
    supportsDisplay: boolean() | nil,
    text: term(),
    timezone: term(),
    type: entity_type()
  }
  | %ExMicrosoftBot.Models.Entity{
      country: String.t() | nil,
      locale: String.t() | nil,
      mentioned: term(),
      name: term(),
      platform: String.t() | nil,
      supportsDisplay: term(),
      text: term(),
      timezone: String.t() | nil,
      type: entity_type()
    }
  | %ExMicrosoftBot.Models.Entity{
      country: term(),
      locale: term(),
      mentioned: ExMicrosoftBot.Models.Entity.Mention.t() | nil,
      name: term(),
      platform: term(),
      supportsDisplay: term(),
      text: String.t() | nil,
      timezone: term(),
      type: entity_type()
    }