CoreTweet  2.0.0-beta.2
Yet another .NET Twitter Library
Public Member Functions | Properties | List of all members
CoreTweet.User Class Reference

Represents a user. More...

Inheritance diagram for CoreTweet.User:
CoreTweet.Core.CoreBase CoreTweet.UserResponse

Public Member Functions

override string ToString ()
 Returns the ID of this instance. More...
 

Properties

bool IsContributorsEnabled [get, set]
 Gets or sets a value that determines if the user has an account with "contributor mode" enabled, allowing for Tweets issued by the user to be co-authored by another account. Rarely true. More...
 
DateTimeOffset CreatedAt [get, set]
 Gets or sets the UTC datetime that the user account was created on Twitter. More...
 
DateTimeOffset Timestamp [get, set]
 Gets or sets the UTC datetime that the user account was created on Twitter. More...
 
bool IsDefaultProfile [get, set]
 Gets or sets a value that determines if the user has not altered the theme or background of its user profile. More...
 
bool IsDefaultProfileImage [get, set]
 Gets or sets a value that determines if the user has not uploaded their own avatar and a default egg avatar is used instead. More...
 
string Description [get, set]
 
string Email [get, set]
 Gets or sets the email address. More...
 
UserEntities Entities [get, set]
 Gets or sets the entities which have been parsed out of the URL or description fields defined by the user. More...
 
int FavouritesCount [get, set]
 
bool? IsFollowRequestSent [get, set]
 
int FollowersCount [get, set]
 
int FriendsCount [get, set]
 
bool? HasExtendedProfile [get, set]
 
bool IsGeoEnabled [get, set]
 
long? Id [get, set]
 Gets or sets the integer representation of the unique identifier for this User. More...
 
bool IsTranslator [get, set]
 Gets or sets a value that determines if the user is a participant in Twitter's translator community. More...
 
bool IsTranslationEnabled [get, set]
 Gets or sets a value that determines if the user is a participant in Twitter's translator community. More...
 
string Language [get, set]
 
int? ListedCount [get, set]
 Gets or sets the number of public lists that the user is a member of. More...
 
string Location [get, set]
 
bool? IsMuting [get, set]
 Gets or sets a value that determines if the user is muted by authenticating user. More...
 
string Name [get, set]
 
bool? NeedsPhoneVerification [get, set]
 
string ProfileBackgroundColor [get, set]
 Gets or sets the hexadecimal color chosen by the user for their background. More...
 
string ProfileBackgroundImageUrl [get, set]
 Gets or sets a HTTP-based URL pointing to the background image the user has uploaded for their profile. More...
 
string ProfileBackgroundImageUrlHttps [get, set]
 Gets or sets a HTTPS-based URL pointing to the background image the user has uploaded for their profile. More...
 
bool IsProfileBackgroundTile [get, set]
 Gets or sets a value that determines if the user's CoreTweet.User.ProfileBackgroundImageUrl should be tiled when displayed. More...
 
string ProfileBannerUrl [get, set]
 Gets or sets a HTTPS-based URL pointing to the standard web representation of the user's uploaded profile banner. By adding a final path element of the URL, you can obtain different image sizes optimized for specific displays. In the future, an API method will be provided to serve these URLs so that you need not modify the original URL. For size variations, please see User Profile Images and Banners. More...
 
string ProfileImageUrl [get, set]
 Gets or sets a HTTP-based URL pointing to the user's avatar image. See User Profile Images and Banners. More...
 
string ProfileImageUrlHttps [get, set]
 Gets or sets a HTTPS-based URL pointing to the user's avatar image. More...
 
string ProfileLinkColor [get, set]
 Gets or sets the hexadecimal color the user has chosen to display links with in their Twitter UI. More...
 
Place ProfileLocation [get, set]
 Gets or sets the user-defined location for this account's profile. More...
 
string ProfileSidebarBorderColor [get, set]
 Gets or sets the hexadecimal color the user has chosen to display sidebar borders with in their Twitter UI. More...
 
string ProfileSidebarFillColor [get, set]
 Gets or sets the hexadecimal color the user has chosen to display sidebar backgrounds with in their Twitter UI. More...
 
string ProfileTextColor [get, set]
 Gets or sets the hexadecimal color the user has chosen to display text with in their Twitter UI. More...
 
bool IsProfileUseBackgroundImage [get, set]
 Gets or sets a value that determines if the user wants their uploaded background image to be used. More...
 
bool IsProtected [get, set]
 Gets or sets a value that determines if the user has chosen to protect their Tweets. More...
 
string ScreenName [get, set]
 
bool? IsShowAllInlineMedia [get, set]
 Gets or sets a value that determines if the user would like to see media inline. Somewhat disused. More...
 
Status Status [get, set]
 
int StatusesCount [get, set]
 Gets or sets the number of tweets (including retweets) issued by the user. More...
 
bool? IsSuspended [get, set]
 Gets or sets a value that determines if the user has been suspended by Twitter. More...
 
string TimeZone [get, set]
 
string TranslatorType [get, set]
 Gets or sets the user's translator type. More...
 
string Url [get, set]
 
int? UtcOffset [get, set]
 
bool IsVerified [get, set]
 Gets or sets a value that determines if the user has a verified account. More...
 
string[] WithheldInCountries [get, set]
 Gets or sets a textual representation of the two-letter country codes this user is withheld from. More...
 
string WithheldScope [get, set]
 Gets or sets the content being withheld is the "status" or a "user." More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreTweet.Core.CoreBase
static T Convert< T > (string json, string jsonPath="")
 Converts the JSON to a twitter object of the specified type. More...
 
static List< T > ConvertArray< T > (string json, string jsonPath)
 

Detailed Description

Represents a user.

Member Function Documentation

◆ ToString()

override string CoreTweet.User.ToString ( )
inline

Returns the ID of this instance.

Returns
The ID of this instance.

Property Documentation

◆ CreatedAt

DateTimeOffset CoreTweet.User.CreatedAt
getset

Gets or sets the UTC datetime that the user account was created on Twitter.

◆ Description

string CoreTweet.User.Description
getset

Gets or sets the user-defined string describing their account.

Nullable.

◆ Email

string CoreTweet.User.Email
getset

Gets or sets the email address.

Nullable.

◆ Entities

UserEntities CoreTweet.User.Entities
getset

Gets or sets the entities which have been parsed out of the URL or description fields defined by the user.

◆ FavouritesCount

int CoreTweet.User.FavouritesCount
getset

Gets or sets the number of tweets this user has favorited in the account's lifetime.

British spelling used in the field name for historical reasons.

◆ FollowersCount

int CoreTweet.User.FollowersCount
getset

Gets or sets the number of followers this account currently has.

Under certain conditions of duress, the field will temporarily indicates 0.

◆ FriendsCount

int CoreTweet.User.FriendsCount
getset

Gets or sets the number of the account is following (AKA its followings).

Under certain conditions of duress, the field will temporarily indicates 0.

◆ HasExtendedProfile

bool? CoreTweet.User.HasExtendedProfile
getset

◆ Id

long? CoreTweet.User.Id
getset

Gets or sets the integer representation of the unique identifier for this User.

◆ IsContributorsEnabled

bool CoreTweet.User.IsContributorsEnabled
getset

Gets or sets a value that determines if the user has an account with "contributor mode" enabled, allowing for Tweets issued by the user to be co-authored by another account. Rarely true.

◆ IsDefaultProfile

bool CoreTweet.User.IsDefaultProfile
getset

Gets or sets a value that determines if the user has not altered the theme or background of its user profile.

◆ IsDefaultProfileImage

bool CoreTweet.User.IsDefaultProfileImage
getset

Gets or sets a value that determines if the user has not uploaded their own avatar and a default egg avatar is used instead.

◆ IsFollowRequestSent

bool? CoreTweet.User.IsFollowRequestSent
getset

Gets or sets a value that determines if the authenticating user has issued a follow request to this protected user account.

Nullable.

◆ IsGeoEnabled

bool CoreTweet.User.IsGeoEnabled
getset

Gets or sets a value that determines if the user has enabled the possibility of geotagging their Tweets.

This field must be true for the current user to attach geographic data when using statuses/update.

◆ IsMuting

bool? CoreTweet.User.IsMuting
getset

Gets or sets a value that determines if the user is muted by authenticating user.

◆ IsProfileBackgroundTile

bool CoreTweet.User.IsProfileBackgroundTile
getset

Gets or sets a value that determines if the user's CoreTweet.User.ProfileBackgroundImageUrl should be tiled when displayed.

◆ IsProfileUseBackgroundImage

bool CoreTweet.User.IsProfileUseBackgroundImage
getset

Gets or sets a value that determines if the user wants their uploaded background image to be used.

◆ IsProtected

bool CoreTweet.User.IsProtected
getset

Gets or sets a value that determines if the user has chosen to protect their Tweets.

◆ IsShowAllInlineMedia

bool? CoreTweet.User.IsShowAllInlineMedia
getset

Gets or sets a value that determines if the user would like to see media inline. Somewhat disused.

◆ IsSuspended

bool? CoreTweet.User.IsSuspended
getset

Gets or sets a value that determines if the user has been suspended by Twitter.

◆ IsTranslationEnabled

bool CoreTweet.User.IsTranslationEnabled
getset

Gets or sets a value that determines if the user is a participant in Twitter's translator community.

◆ IsTranslator

bool CoreTweet.User.IsTranslator
getset

Gets or sets a value that determines if the user is a participant in Twitter's translator community.

◆ IsVerified

bool CoreTweet.User.IsVerified
getset

Gets or sets a value that determines if the user has a verified account.

◆ Language

string CoreTweet.User.Language
getset

Gets or sets the BCP 47 code for the user's self-declared user interface language.

May or may not have anything to do with the content of their Tweets.

◆ ListedCount

int? CoreTweet.User.ListedCount
getset

Gets or sets the number of public lists that the user is a member of.

◆ Location

string CoreTweet.User.Location
getset

Gets or sets the user-defined location for this account's profile.

Not necessarily a location nor parsable.

This field will occasionally be fuzzily interpreted by the Search service.

Nullable.

◆ Name

string CoreTweet.User.Name
getset

Gets or sets the name of the user, as they've defined it.

Not necessarily a person's name.

Typically capped at 20 characters, but subject to be changed.

◆ NeedsPhoneVerification

bool? CoreTweet.User.NeedsPhoneVerification
getset

◆ ProfileBackgroundColor

string CoreTweet.User.ProfileBackgroundColor
getset

Gets or sets the hexadecimal color chosen by the user for their background.

◆ ProfileBackgroundImageUrl

string CoreTweet.User.ProfileBackgroundImageUrl
getset

Gets or sets a HTTP-based URL pointing to the background image the user has uploaded for their profile.

◆ ProfileBackgroundImageUrlHttps

string CoreTweet.User.ProfileBackgroundImageUrlHttps
getset

Gets or sets a HTTPS-based URL pointing to the background image the user has uploaded for their profile.

◆ ProfileBannerUrl

string CoreTweet.User.ProfileBannerUrl
getset

Gets or sets a HTTPS-based URL pointing to the standard web representation of the user's uploaded profile banner. By adding a final path element of the URL, you can obtain different image sizes optimized for specific displays. In the future, an API method will be provided to serve these URLs so that you need not modify the original URL. For size variations, please see User Profile Images and Banners.

◆ ProfileImageUrl

string CoreTweet.User.ProfileImageUrl
getset

Gets or sets a HTTP-based URL pointing to the user's avatar image. See User Profile Images and Banners.

◆ ProfileImageUrlHttps

string CoreTweet.User.ProfileImageUrlHttps
getset

Gets or sets a HTTPS-based URL pointing to the user's avatar image.

◆ ProfileLinkColor

string CoreTweet.User.ProfileLinkColor
getset

Gets or sets the hexadecimal color the user has chosen to display links with in their Twitter UI.

◆ ProfileLocation

Place CoreTweet.User.ProfileLocation
getset

Gets or sets the user-defined location for this account's profile.

◆ ProfileSidebarBorderColor

string CoreTweet.User.ProfileSidebarBorderColor
getset

Gets or sets the hexadecimal color the user has chosen to display sidebar borders with in their Twitter UI.

◆ ProfileSidebarFillColor

string CoreTweet.User.ProfileSidebarFillColor
getset

Gets or sets the hexadecimal color the user has chosen to display sidebar backgrounds with in their Twitter UI.

◆ ProfileTextColor

string CoreTweet.User.ProfileTextColor
getset

Gets or sets the hexadecimal color the user has chosen to display text with in their Twitter UI.

◆ ScreenName

string CoreTweet.User.ScreenName
getset

Gets or sets the screen name, handle, or alias that this user identifies themselves with.

ScreenName are unique but subject to be changed.

Use Id as a user identifier whenever possible.

Typically a maximum of 15 characters long, but some historical accounts may exist with longer names.

◆ Status

Status CoreTweet.User.Status
getset

Gets or sets the user's most recent tweet or retweet.

In some circumstances, this data cannot be provided and this field will be omitted, null, or empty.

Perspectival attributes within tweets embedded within users cannot always be relied upon.

◆ StatusesCount

int CoreTweet.User.StatusesCount
getset

Gets or sets the number of tweets (including retweets) issued by the user.

◆ Timestamp

DateTimeOffset CoreTweet.User.Timestamp
getset

Gets or sets the UTC datetime that the user account was created on Twitter.

This property will be set for Account Activity API.

◆ TimeZone

string CoreTweet.User.TimeZone
getset

Gets or sets the string describes the time zone the user declares themselves within.

Nullable.

◆ TranslatorType

string CoreTweet.User.TranslatorType
getset

Gets or sets the user's translator type.

◆ Url

string CoreTweet.User.Url
getset

Gets or sets the URL provided by the user in association with their profile.

Nullable.

◆ UtcOffset

int? CoreTweet.User.UtcOffset
getset

Gets or sets the offset from GMT/UTC in seconds.

Nullable.

◆ WithheldInCountries

string [] CoreTweet.User.WithheldInCountries
getset

Gets or sets a textual representation of the two-letter country codes this user is withheld from.

◆ WithheldScope

string CoreTweet.User.WithheldScope
getset

Gets or sets the content being withheld is the "status" or a "user."


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