PHP Class Slack\User

Inheritance: extends slack\ClientObject
Mostra file Open project: coderstephen/slack-client Class Usage Examples

Public Methods

Method Description
getEmail ( ) : string Gets the user's email address if supplied.
getFirstName ( ) : string Gets the user's first name if supplied.
getId ( ) : string Gets the user's ID.
getLastName ( ) : string Gets the user's last name if supplied.
getPhone ( ) : string Gets the user's phone number if supplied.
getPresence ( ) : React\Promise\PromiseInterface Gets a user's presence.
getProfileImage192 ( ) : string User profile image URL 192x192px
getProfileImage24 ( ) : string User profile image URL 24x24px
getProfileImage32 ( ) : string User profile image URL 32x32px
getProfileImage48 ( ) : string User profile image URL 48x48px
getProfileImage72 ( ) : string User profile image URL 72x72px
getRealName ( ) : string Gets the user's real name if supplied.
getSkype ( ) : string Gets the user's Skype name if supplied.
getUsername ( ) : string Gets the user's username.
isAdmin ( ) : boolean Checks if the user is a team administrator.
isDeleted ( ) : boolean Checks if the user has been deactivated.
isOwner ( ) : boolean Checks if the user is a team owner.
isPrimaryOwner ( ) : boolean Checks if the user is the team's primary owner.

Method Details

getEmail() public method

Gets the user's email address if supplied.
public getEmail ( ) : string
return string The user's email address, or null if no email was given.

getFirstName() public method

Gets the user's first name if supplied.
public getFirstName ( ) : string
return string The user's first name, or null if no name was given.

getId() public method

Gets the user's ID.
public getId ( ) : string
return string The user's ID.

getLastName() public method

Gets the user's last name if supplied.
public getLastName ( ) : string
return string The user's last name, or null if no name was given.

getPhone() public method

Gets the user's phone number if supplied.
public getPhone ( ) : string
return string The user's phone number, or null if no number was given.

getPresence() public method

Gets a user's presence.
public getPresence ( ) : React\Promise\PromiseInterface
return React\Promise\PromiseInterface The current user's presence, either "active" or "away".

getProfileImage192() public method

User profile image URL 192x192px
public getProfileImage192 ( ) : string
return string URL of the 192x192px user profile image

getProfileImage24() public method

User profile image URL 24x24px
public getProfileImage24 ( ) : string
return string URL of the 24x24px user profile image

getProfileImage32() public method

User profile image URL 32x32px
public getProfileImage32 ( ) : string
return string URL of the 32x32px user profile image

getProfileImage48() public method

User profile image URL 48x48px
public getProfileImage48 ( ) : string
return string URL of the 48x48px user profile image

getProfileImage72() public method

User profile image URL 72x72px
public getProfileImage72 ( ) : string
return string URL of the 72x72px user profile image

getRealName() public method

Gets the user's real name if supplied.
public getRealName ( ) : string
return string The user's real name, or null if no name was given.

getSkype() public method

Gets the user's Skype name if supplied.
public getSkype ( ) : string
return string The user's Skype name, or null if no Skype name was given.

getUsername() public method

Does not include the @ symbol at the beginning.
public getUsername ( ) : string
return string The user's username.

isAdmin() public method

Checks if the user is a team administrator.
public isAdmin ( ) : boolean
return boolean True if the user is a team administrator.

isDeleted() public method

Checks if the user has been deactivated.
public isDeleted ( ) : boolean
return boolean True if the user is deactivated.

isOwner() public method

Checks if the user is a team owner.
public isOwner ( ) : boolean
return boolean True if the user is a team owner.

isPrimaryOwner() public method

Checks if the user is the team's primary owner.
public isPrimaryOwner ( ) : boolean
return boolean True if the user is the primary team owner.