aerogear-xamarin-sdk
AeroGear Xamarin SDK
AeroGear.Mobile.Auth.User Class Reference

This class represent an authenticated user. More...

Public Member Functions

ICollection< UserRolegetRoles ()
 Gets the roles. More...
 
bool HasResourceRole (string role, string resourceId)
 Checks if the user has the specified Resource role. More...
 
bool HasRealmRole (string role)
 Checks if the user has the specified Realm role.. More...
 

Static Public Member Functions

static UserBuilder NewUser ()
 Instantiate a new user object with a fluent api. More...
 

Public Attributes

List< UserRoleRoles
 Roles associated with this principal. More...
 

Properties

string Username [get]
 Gets the username. More...
 
string Firstname [get]
 Gets the firstname. More...
 
string Lastname [get]
 Gets the lastname. More...
 
string Email [get]
 Gets the email. More...
 
string IdentityToken [get]
 Gets the identity token. More...
 
string AccessToken [get]
 Gets the access token. More...
 
string RefreshToken [get]
 Gets the refresh token. More...
 

Detailed Description

This class represent an authenticated user.

Member Function Documentation

◆ getRoles()

ICollection<UserRole> AeroGear.Mobile.Auth.User.getRoles ( )

Gets the roles.

Returns
All the roles associated with this user.

◆ HasRealmRole()

bool AeroGear.Mobile.Auth.User.HasRealmRole ( string  role)

Checks if the user has the specified Realm role..

Returns
true, if the passed in role is associated with this user, false otherwise.
Parameters
rolerole to be checked.

◆ HasResourceRole()

bool AeroGear.Mobile.Auth.User.HasResourceRole ( string  role,
string  resourceId 
)

Checks if the user has the specified Resource role.

Returns
true, if the passed in role is associated with this user, false otherwise.
Parameters
rolerole to be checked.
resourceIdresourceId related to role.

◆ NewUser()

static UserBuilder AeroGear.Mobile.Auth.User.NewUser ( )
static

Instantiate a new user object with a fluent api.

Returns
The user, ready to be configured with fluent api.

Member Data Documentation

◆ Roles

List<UserRole> AeroGear.Mobile.Auth.User.Roles

Roles associated with this principal.

Property Documentation

◆ AccessToken

string AeroGear.Mobile.Auth.User.AccessToken
get

Gets the access token.

Access token for http request authorisation.

◆ Email

string AeroGear.Mobile.Auth.User.Email
get

Gets the email.

The email associated with this user.

◆ Firstname

string AeroGear.Mobile.Auth.User.Firstname
get

Gets the firstname.

The first name of the principal.

◆ IdentityToken

string AeroGear.Mobile.Auth.User.IdentityToken
get

Gets the identity token.

Identity token. It is used for logout.

◆ Lastname

string AeroGear.Mobile.Auth.User.Lastname
get

Gets the lastname.

The last name of the principal.

◆ RefreshToken

string AeroGear.Mobile.Auth.User.RefreshToken
get

Gets the refresh token.

The refresh token.

◆ Username

string AeroGear.Mobile.Auth.User.Username
get

Gets the username.

The username of the principal.


The documentation for this class was generated from the following file: