Interface IUserProfileBase
Describes a generic user profile.
Inherited Members
Namespace: StrixMusic.Sdk.BaseModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface IUserProfileBase : IImageCollectionBase, ICollectionBase
Properties
| Improve this Doc View SourceBirthdate
The DateTime the user was born.
Declaration
DateTime? Birthdate { get; }
Property Value
Type | Description |
---|---|
DateTime? |
Remarks
If missing data, replace the day, month and/or year with part of 1/1/1970.
DisplayName
Username shown to the user or others
Declaration
string DisplayName { get; }
Property Value
Type | Description |
---|---|
string |
The user's email
Declaration
string? Email { get; }
Property Value
Type | Description |
---|---|
string |
FullName
The user's full name
Declaration
string? FullName { get; }
Property Value
Type | Description |
---|---|
string |
Id
Identifier for the user
Declaration
string Id { get; }
Property Value
Type | Description |
---|---|
string |
IsChangeBirthDateAsyncAvailable
If true, ChangeBirthDateAsync(DateTime, CancellationToken) is supported.
Declaration
bool IsChangeBirthDateAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeDisplayNameAvailable
If true, ChangeDisplayNameAsync(string, CancellationToken) is supported.
Declaration
bool IsChangeDisplayNameAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeEmailAsyncAvailable
If true, ChangeEmailAsync(string?, CancellationToken) is supported.
Declaration
bool IsChangeEmailAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeFullNameAsyncAsyncAvailable
If true, ChangeFullNameAsync(string, CancellationToken) is supported.
Declaration
bool IsChangeFullNameAsyncAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeRegionAsyncAvailable
If true, ChangeRegionAsync(CultureInfo, CancellationToken) is supported.
Declaration
bool IsChangeRegionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
Region
The user's country or region of origin.
Declaration
CultureInfo Region { get; }
Property Value
Type | Description |
---|---|
CultureInfo |
Methods
| Improve this Doc View SourceChangeBirthDateAsync(DateTime, CancellationToken)
Changes the Birthdate for this user.
Declaration
Task ChangeBirthDateAsync(DateTime birthdate, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
DateTime | birthdate | The new birthdate. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeDisplayNameAsync(string, CancellationToken)
Changes the DisplayName for this user.
Declaration
Task ChangeDisplayNameAsync(string displayName, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | displayName | The new display name. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeEmailAsync(string?, CancellationToken)
Changes the Email for this user.
Declaration
Task ChangeEmailAsync(string? email, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | The new email. |
|
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeFullNameAsync(string, CancellationToken)
Changes the FullName for this user.
Declaration
Task ChangeFullNameAsync(string fullname, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | fullname | The full name. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeRegionAsync(CultureInfo, CancellationToken)
Changes the Region for this user.
Declaration
Task ChangeRegionAsync(CultureInfo region, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CultureInfo | region | The new region. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Events
| Improve this Doc View SourceBirthDateChanged
Fires when the Birthdate has changed.
Declaration
event EventHandler<DateTime>? BirthDateChanged
Event Type
Type | Description |
---|---|
EventHandler<DateTime> |
DisplayNameChanged
Fires when the DisplayName has changed.
Declaration
event EventHandler<string>? DisplayNameChanged
Event Type
Type | Description |
---|---|
EventHandler<string> |
EmailChanged
Fires when the Email has changed.
Declaration
event EventHandler<string?>? EmailChanged
Event Type
Type | Description |
---|---|
EventHandler<string> |
FullNameChanged
Fires when the FullName has changed.
Declaration
event EventHandler<string>? FullNameChanged
Event Type
Type | Description |
---|---|
EventHandler<string> |
RegionChanged
Fires when the Region has changed.
Declaration
event EventHandler<CultureInfo>? RegionChanged
Event Type
Type | Description |
---|---|
EventHandler<CultureInfo> |