Content created on the site must implement this interface for the social services to support it.
User is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace.
Definition
class User : LazyContentApiEntityWithExtendedAttributes<User>, IApiEntity, IApplication, IContainer, IExtendedAuditable, IFileReviewableContent, ITextReviewableContent { User(); User(AdditionalInfo additionalInfo); User(Error error); User(Warning warning); User(User coreUser, IUserHelperService userHelperService, IContextService contextService, ISecurityService securityService, IUserProfileService userProfileService, bool enablePoints, User originalUser); string AccountStatus { get; set; } bool? AllowSitePartnersToContact { get; set; } bool? AllowSiteToContact { get; set; } string AuthenticatedSessionState { get; set; } string AvatarUrl { get; } DateTime? BannedUntil { get; set; } string BanReason { get; set; } DateTime? Birthday { get; set; } Guid ContentId { get; set; } string ConversationContactType { get; set; } string CoverPhotoUrl { get; } string DateFormat { get; set; } string DisplayName { get; set; } string EditorType { get; set; } bool? EnableCollapsingPanels { get; set; } bool? EnableCommentNotifications { get; set; } bool? EnableConversationNotifications { get; set; } IList<string> EnabledActivityMessageTypes { get; } bool? EnableDisplayInMemberList { get; set; } bool? EnableDisplayName { get; set; } bool? EnableEmail { get; set; } bool? EnableEmoticons { get; set; } bool? EnableFavoriteSharing { get; set; } bool? EnableHtmlEmail { get; set; } bool? EnablePostPreviewPopup { get; set; } bool EnablePresenceTracking { get; set; } bool? EnableTracking { get; set; } bool? EnableUserSignatures { get; set; } IList<Error> Errors { get; } ApiList<ExtendedAttribute> ExtendedAttributes { get; set; } bool? ForceLogin { get; set; } string Gender { get; set; } bool? HasPassword { get; set; } int? Id { get; set; } bool? IsEmailVerified { get; set; } bool? IsIgnored { get; set; } bool? IsSystemAccount { get; set; } DateTime? JoinDate { get; set; } string Language { get; set; } DateTime? LastLoginDate { get; set; } DateTime? LastVisitedDate { get; set; } string Location { get; set; } string ModerationLevel { get; set; } string Password { get; set; } int? Points { get; set; } string PostSortOrder { get; set; } string Presence { get; set; } string PrivateEmail { get; set; } ApiList<ProfileField> ProfileFields { get; set; } string ProfileUrl { get; set; } string PublicEmail { get; set; } int? QualityPercentile { get; set; } string RawBio { get; set; } bool RequiresTermsOfServiceAcceptance { get; } string RolesCacheKey { get; } IList<string> RssFeeds { get; set; } string Signature { get; set; } string SignatureFormatted { get; set; } DateTime? TermsOfServiceAcceptanceDate { get; set; } double? TimeZone { get; set; } string TimeZoneId { get; set; } TimeZoneInfo TimeZoneInfo { get; } int TotalPosts { get; set; } string Url { get; } string Username { get; set; } IList<Warning> Warnings { get; } string WebUrl { get; set; } string Bio(); string Bio(string postTarget); bool HasErrors(); bool HasWarnings(); bool HasWarningsOrErrors(); void ThrowErrors(); }
Constructors
User();
User(AdditionalInfo additionalInfo);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| additionalInfo | AdditionalInfo | Additional Info | Required |
User(Error error);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| error | Error | Error | Required |
User(Warning warning);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warning | Warning | Warning | Required |
User(User coreUser, IUserHelperService userHelperService, IContextService contextService, ISecurityService securityService, IUserProfileService userProfileService, bool enablePoints, User originalUser);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| coreUser | User | Core User | Required | ||
| userHelperService | IUserHelperService | User Helper Service | Required | ||
| contextService | IContextService | Context Service | Required | ||
| securityService | ISecurityService | Security Service | Required | ||
| userProfileService | IUserProfileService | User Profile Service | Required | ||
| enablePoints | bool | Enable Points | Required | ||
| originalUser | User | Original User | Required |
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| AccountStatus | string | |||
| AllowSitePartnersToContact | bool? | |||
| AllowSiteToContact | bool? | |||
| AuthenticatedSessionState | string | |||
| AvatarUrl | string | Url to an image particular to the content or content type. If none, return null. | ||
| BannedUntil | DateTime? | |||
| BanReason | string | |||
| Birthday Obsolete | DateTime? | Obsolete in 13: Use profile fields instead. | ||
| ContentId | Guid | A Guid uniquely identifying the content. | ||
| ConversationContactType | string | |||
| CoverPhotoUrl | string | |||
| DateFormat | string | |||
| DisplayName | string | |||
| EditorType Obsolete | string | Obsolete in 12 | ||
| EnableCollapsingPanels | bool? | |||
| EnableCommentNotifications | bool? | |||
| EnableConversationNotifications | bool? | |||
| EnabledActivityMessageTypes | IList<string> | |||
| EnableDisplayInMemberList | bool? | |||
| EnableDisplayName | bool? | |||
| EnableEmail | bool? | |||
| EnableEmoticons Obsolete | bool? | Obsolete in 12 | ||
| EnableFavoriteSharing | bool? | |||
| EnableHtmlEmail | bool? | |||
| EnablePostPreviewPopup | bool? | |||
| EnablePresenceTracking | bool | |||
| EnableTracking Obsolete | bool? | Obsolete in 12 | ||
| EnableUserSignatures | bool? | |||
| Errors | IList<Error> | |||
| ExtendedAttributes | ApiList<ExtendedAttribute> | |||
| ForceLogin Obsolete | bool? | Obsolete in 12.1 Obsolete in 12.1 | ||
| Gender Obsolete | string | Obsolete in 13: Use profile fields instead. | ||
| HasPassword | bool? | |||
| Id | int? | |||
| IsEmailVerified | bool? | |||
| IsIgnored | bool? | |||
| IsSystemAccount | bool? | |||
| JoinDate | DateTime? | |||
| Language | string | |||
| LastLoginDate | DateTime? | |||
| LastVisitedDate | DateTime? | |||
| Location Obsolete | string | Obsolete in 13: Use profile fields instead. | ||
| ModerationLevel | string | |||
| Password | string | |||
| Points | int? | |||
| PostSortOrder | string | |||
| Presence | string | |||
| PrivateEmail | string | |||
| ProfileFields | ApiList<ProfileField> | |||
| ProfileUrl | string | |||
| PublicEmail | string | |||
| QualityPercentile | int? | |||
| RawBio | string | |||
| RequiresTermsOfServiceAcceptance | bool | |||
| RolesCacheKey | string | |||
| RssFeeds | IList<string> | |||
| Signature | string | |||
| SignatureFormatted Obsolete | string | Obsolete in 13: Use Signature Instead. | ||
| TermsOfServiceAcceptanceDate | DateTime? | |||
| TimeZone | double? | |||
| TimeZoneId | string | |||
| TimeZoneInfo | TimeZoneInfo | |||
| TotalPosts | int | |||
| Url | string | A Url to the content on the site. | ||
| Username | string | |||
| Warnings | IList<Warning> | |||
| WebUrl Obsolete | string | Obsolete in 13: Use profile fields instead. |
Methods
string Bio();
Return Type
string Bio(string postTarget);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| postTarget | string | Post Target | Required |