interface FossabotUser implements FossabotDataModel (View source)

Fossabot user context data model. Contains information about the user that invoked the custom API request.

Methods

string
__toString()

String representation of the object.

string
toString()

String representation of the object. For complex objects, this would normally be a JSON string.

string
toJson(int $options = 0)

Convert the object to its JSON representation.

from  Jsonable
toArray()

No description

createFromBody(array $body)

Creates a new Fossabot data model instance from a parsed array of API data.

string
providerId()

Message user provider ID.

string
login()

Message user login name, the lowercased version.

string
displayName()

Message user display name, uppercased or localized display name.

array
roles()

Array of user roles.

Details

string __toString()

String representation of the object.

Return Value

string

String representation of the object

string toString()

String representation of the object. For complex objects, this would normally be a JSON string.

Return Value

string

String representation of the object

string toJson(int $options = 0)

Convert the object to its JSON representation.

Parameters

int $options

JSON encode options

Return Value

string

JSON string

toArray()

No description

static FossabotDataModel createFromBody(array $body)

Creates a new Fossabot data model instance from a parsed array of API data.

Parameters

array $body

Parsed API body

Return Value

FossabotDataModel

string providerId()

Message user provider ID.

Return Value

string

string login()

Message user login name, the lowercased version.

Return Value

string

string displayName()

Message user display name, uppercased or localized display name.

Return Value

string

array roles()

Array of user roles.

Return Value

array