UserDisplay
in package
Class UserDisplay
Represents Canvas's abbreviated "UserDisplay" user representation. Canvas embeds this
compact object (rather than a full User resource) on other objects when the API is asked
to include user information alongside them, e.g. the uploader of a file when a course's
file listing is requested with include[]=user.
This is a read-only data object with no API endpoints of its own - it is only ever returned nested inside another resource's response.
Tags
Table of Contents
Properties
- $anonymousId : string|null
- Optional: This user's anonymous id, for use in an assignment with anonymous grading or peer review
- $avatarImageUrl : string|null
- If avatars are enabled, this will be a URL to the user's avatar
- $displayName : string|null
- A short name the user has selected, for use in conversations or other less formal contexts
- $htmlUrl : string|null
- URL to access user, either nested to a context or directly
- $id : int|null
- The user's ID
- $pronouns : string|null
- Optional: This user's pronouns
Methods
- __construct() : mixed
- UserDisplay constructor.
Properties
$anonymousId
Optional: This user's anonymous id, for use in an assignment with anonymous grading or peer review
public
string|null
$anonymousId
= null
$avatarImageUrl
If avatars are enabled, this will be a URL to the user's avatar
public
string|null
$avatarImageUrl
= null
$displayName
A short name the user has selected, for use in conversations or other less formal contexts
public
string|null
$displayName
= null
$htmlUrl
URL to access user, either nested to a context or directly
public
string|null
$htmlUrl
= null
$id
The user's ID
public
int|null
$id
= null
$pronouns
Optional: This user's pronouns
public
string|null
$pronouns
= null
Methods
__construct()
UserDisplay constructor.
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []