View Source Tw.V1_1.UserMention (Tw v0.1.1)

UserMention data structure and related functions. https://developer.twitter.com/en/docs/twitter-api/v1/data-dictionary/object-model/entities

Link to this section Summary

Types

t()
fielddescription
idID of the mentioned user, as an integer. Example: 6253282.
id_strIf of the mentioned user, as a string. Example: "6253282".
indicesAn array of integers representing the offsets within the Tweet text where the user reference begins and ends. The first integer represents the location of the ‘@’ character of the user mention. The second integer represents the location of the first non-screenname character following the user mention. Example: [4,15].
nameDisplay name of the referenced user. Example: "Twitter API".
screen_nameScreen name of the referenced user. Example: "twitterapi".

Functions

Decode JSON-decoded map into t/0

Link to this section Types

Specs

t() :: %Tw.V1_1.UserMention{
  id: integer(),
  id_str: binary(),
  indices: [integer()],
  name: binary(),
  screen_name: binary()
}
fielddescription
idID of the mentioned user, as an integer. Example: 6253282.
id_strIf of the mentioned user, as a string. Example: "6253282".
indicesAn array of integers representing the offsets within the Tweet text where the user reference begins and ends. The first integer represents the location of the ‘@’ character of the user mention. The second integer represents the location of the first non-screenname character following the user mention. Example: [4,15].
nameDisplay name of the referenced user. Example: "Twitter API".
screen_nameScreen name of the referenced user. Example: "twitterapi".

Link to this section Functions

Specs

decode!(map()) :: t()

Decode JSON-decoded map into t/0