C# Class BoxKite.Twitter.UsersExtensions

Mostrar archivo Open project: nickhodge/BoxKite.Twitter

Public Methods

Method Description
ChangeAccountBackgroundImage ( this session, string fileName, Stream imageDataStream, bool tile = true, bool useImage = true ) : Task

Updates the authenticating user's background image as displayed on twitter.com.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_background_image

ChangeAccountBackgroundImage ( this session, string fileName, byte imageContent, bool tile = true, bool useImage = true ) : Task

Updates the authenticating user's background image as displayed on twitter.com.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_background_image

ChangeAccountColours ( this session, string profileBackgroundColor = "", string profileLinkColor = "", string profileSidebarBorderColor = "", string profileSidebarFillColor = "", string profileTextColor = "" ) : Task

Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. Each parameter's value must be a valid hexidecimal value, and may be either three or six characters (ex: #fff or #ffffff).

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_colors

ChangeAccountProfile ( this session, string name = "", string profileUrl = "", string location = "", string description = "" ) : Task

Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile

ChangeAccountProfileImage ( this session, string fileName, Stream imageContentStream ) : Task

Updates the authenticating user's profile image.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_image

ChangeAccountProfileImage ( this session, string fileName, byte imageContent ) : Task

Updates the authenticating user's profile image.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_image

ChangeAccountSettings ( this session, string trendLocationWoeid = "1", bool sleepTimeEnabled = false, string startSleepTime = "", string endSleepTime = "", string timeZone = "", string language = "" ) : Task

Updates the authenticating user's settings.

ref: https://dev.twitter.com/docs/api/1.1/post/account/settings

ChangeProfileBanner ( this session, string fileName, Stream imageContentStream, int bannerWidth, int bannerHeight, int bannerLeftOffset, int bannerTopOffset ) : Task

Removes the uploaded profile banner for the authenticating user. Returns HTTP 20x upon success.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_banner

ChangeProfileBanner ( this session, string fileName, byte imageContent, int bannerWidth, int bannerHeight, int bannerLeftOffset, int bannerTopOffset ) : Task

Removes the uploaded profile banner for the authenticating user. Returns HTTP 20x upon success.

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_banner

ChangeUpdateDeliverySettings ( this session, string device = "none" ) : Task

Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable SMS updates

ref: https://dev.twitter.com/docs/api/1.1/post/account/update_delivery_device

CreateUserBlock ( this session, string screenName = "", long userId ) : Task

Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.

ref: https://dev.twitter.com/docs/api/1.1/post/blocks/create

DeleteProfileBanner ( this session ) : Task

Removes the uploaded profile banner for the authenticating user. Returns HTTP 200 upon success.

ref: https://dev.twitter.com/docs/api/1.1/post/account/remove_profile_banner

DeleteUserBlock ( this session, string screenName = "", long userId ) : Task

Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored.

ref: https://dev.twitter.com/docs/api/1.1/post/blocks/destroy

GetAccountSettings ( this session ) : Task

Returns settings (including current trend, geo and sleep time information) for the authenticating user.

ref: https://dev.twitter.com/docs/api/1.1/get/account/settings

GetBlockList ( this session, long cursor = -1 ) : Task

Returns a collection of user objects that the authenticating user is blocking.

ref: https://dev.twitter.com/docs/api/1.1/get/blocks/list

GetConfiguration ( this session ) : Task

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

ref: https://dev.twitter.com/rest/reference/get/help/configuration

GetProfileBanners ( this session, string screenName = "", long userId ) : Task

Returns a map of the available size variations of the specified user's profile banner.

ref: https://dev.twitter.com/docs/api/1.1/get/users/profile_banner

GetUserProfile ( this session, string screenName = "", long userId ) : Task

Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author's most recent Tweet will be returned inline when possible.
GetUsersDetailsFull ( this session, IEnumerable screenNames = null, IEnumerable userIds = null ) : Task>

Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters.

ref: https://dev.twitter.com/docs/api/1.1/get/users/lookup

GetVerifyCredentials ( this session ) : Task

Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.
SearchForUsers ( this session, string searchQuery, int count = 20, int page = 1 ) : Task>

Provides a simple, relevance-based search interface to public user accounts on Twitter. Only the first 1,000 matching results are available.

ref: https://dev.twitter.com/docs/api/1.1/get/users/search

Method Details

ChangeAccountBackgroundImage() public static method

Updates the authenticating user's background image as displayed on twitter.com.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_background_image
public static ChangeAccountBackgroundImage ( this session, string fileName, Stream imageDataStream, bool tile = true, bool useImage = true ) : Task
session this
fileName string
imageDataStream System.IO.Stream Stream of image content
tile bool True or false to tile
useImage bool Turn on/off image on background
return Task

ChangeAccountBackgroundImage() public static method

Updates the authenticating user's background image as displayed on twitter.com.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_background_image
public static ChangeAccountBackgroundImage ( this session, string fileName, byte imageContent, bool tile = true, bool useImage = true ) : Task
session this
fileName string
imageContent byte byte array of image content
tile bool True or false to tile
useImage bool Turn on/off image on background
return Task

ChangeAccountColours() public static method

Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. Each parameter's value must be a valid hexidecimal value, and may be either three or six characters (ex: #fff or #ffffff).
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_colors
public static ChangeAccountColours ( this session, string profileBackgroundColor = "", string profileLinkColor = "", string profileSidebarBorderColor = "", string profileSidebarFillColor = "", string profileTextColor = "" ) : Task
session this
profileBackgroundColor string Example Values: 3D3D3D
profileLinkColor string Example Values: 3D3D3D
profileSidebarBorderColor string Example Values: 3D3D3D
profileSidebarFillColor string Example Values: 3D3D3D
profileTextColor string Example Values: 3D3D3D
return Task

ChangeAccountProfile() public static method

Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile
public static ChangeAccountProfile ( this session, string name = "", string profileUrl = "", string location = "", string description = "" ) : Task
session this
name string Full name associated with the profile. Maximum of 20 characters.
profileUrl string URL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.
location string The city or country describing where the user of the account is located.
description string A description of the user owning the account. Maximum of 160 characters.
return Task

ChangeAccountProfileImage() public static method

Updates the authenticating user's profile image.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_image
public static ChangeAccountProfileImage ( this session, string fileName, Stream imageContentStream ) : Task
session this
fileName string file name for upload
imageContentStream System.IO.Stream Stream pointing to the image data
return Task

ChangeAccountProfileImage() public static method

Updates the authenticating user's profile image.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_image
public static ChangeAccountProfileImage ( this session, string fileName, byte imageContent ) : Task
session this
fileName string file name for upload
imageContent byte byte array of image content
return Task

ChangeAccountSettings() public static method

Updates the authenticating user's settings.
ref: https://dev.twitter.com/docs/api/1.1/post/account/settings
public static ChangeAccountSettings ( this session, string trendLocationWoeid = "1", bool sleepTimeEnabled = false, string startSleepTime = "", string endSleepTime = "", string timeZone = "", string language = "" ) : Task
session this
trendLocationWoeid string The Yahoo! Where On Earth ID to use as the user's default trend location.
sleepTimeEnabled bool enable sleep time for the user. Sleep time is the time when push or SMS notifications should not be sent to the user.
startSleepTime string The hour that sleep time should begin if it is enabled. (00)
endSleepTime string The hour that sleep time should end if it is enabled. (23)
timeZone string The timezone dates and times should be displayed in for the user. http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
language string The language which Twitter should render in for this user https://dev.twitter.com/docs/api/1/get/help/languages
return Task

ChangeProfileBanner() public static method

Removes the uploaded profile banner for the authenticating user. Returns HTTP 20x upon success.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_banner
public static ChangeProfileBanner ( this session, string fileName, Stream imageContentStream, int bannerWidth, int bannerHeight, int bannerLeftOffset, int bannerTopOffset ) : Task
session this
fileName string file name for upload
imageContentStream System.IO.Stream Stream of image content
bannerWidth int The width of the preferred section of the image being uploaded in pixels. Use with height, offset_left, and offset_top to select the desired region of the image to use.
bannerHeight int The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.
bannerLeftOffset int The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.
bannerTopOffset int The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.
return Task

ChangeProfileBanner() public static method

Removes the uploaded profile banner for the authenticating user. Returns HTTP 20x upon success.
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_profile_banner
public static ChangeProfileBanner ( this session, string fileName, byte imageContent, int bannerWidth, int bannerHeight, int bannerLeftOffset, int bannerTopOffset ) : Task
session this
fileName string file name for upload
imageContent byte byte array of image content
bannerWidth int The width of the preferred section of the image being uploaded in pixels. Use with height, offset_left, and offset_top to select the desired region of the image to use.
bannerHeight int The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.
bannerLeftOffset int The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.
bannerTopOffset int The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.
return Task

ChangeUpdateDeliverySettings() public static method

Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable SMS updates
ref: https://dev.twitter.com/docs/api/1.1/post/account/update_delivery_device
public static ChangeUpdateDeliverySettings ( this session, string device = "none" ) : Task
session this
device string none or sms
return Task

CreateUserBlock() public static method

Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.
ref: https://dev.twitter.com/docs/api/1.1/post/blocks/create
public static CreateUserBlock ( this session, string screenName = "", long userId ) : Task
session this
screenName string The screen name of the potentially blocked user.
userId long The ID of the potentially blocked user.
return Task

DeleteProfileBanner() public static method

Removes the uploaded profile banner for the authenticating user. Returns HTTP 200 upon success.
ref: https://dev.twitter.com/docs/api/1.1/post/account/remove_profile_banner
public static DeleteProfileBanner ( this session ) : Task
session this
return Task

DeleteUserBlock() public static method

Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored.
ref: https://dev.twitter.com/docs/api/1.1/post/blocks/destroy
public static DeleteUserBlock ( this session, string screenName = "", long userId ) : Task
session this
screenName string The screen name of the potentially blocked user.
userId long The ID of the potentially blocked user.
return Task

GetAccountSettings() public static method

Returns settings (including current trend, geo and sleep time information) for the authenticating user.
ref: https://dev.twitter.com/docs/api/1.1/get/account/settings
public static GetAccountSettings ( this session ) : Task
session this
return Task

GetBlockList() public static method

Returns a collection of user objects that the authenticating user is blocking.
ref: https://dev.twitter.com/docs/api/1.1/get/blocks/list
public static GetBlockList ( this session, long cursor = -1 ) : Task
session this
cursor long Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time.
return Task

GetConfiguration() public static method

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.
ref: https://dev.twitter.com/rest/reference/get/help/configuration
public static GetConfiguration ( this session ) : Task
session this
return Task

GetProfileBanners() public static method

Returns a map of the available size variations of the specified user's profile banner.
ref: https://dev.twitter.com/docs/api/1.1/get/users/profile_banner
public static GetProfileBanners ( this session, string screenName = "", long userId ) : Task
session this
screenName string The screen name of the user for whom to return results for.
userId long The ID of the user for whom to return results for.
return Task

GetUserProfile() public static method

Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author's most recent Tweet will be returned inline when possible.
public static GetUserProfile ( this session, string screenName = "", long userId ) : Task
session this
screenName string The screen name of the user for whom to return results for. Either a id or screen_name is required for this method.
userId long The ID of the user for whom to return results for. Either an id or screen_name is required for this method.
return Task

GetUsersDetailsFull() public static method

Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters.
ref: https://dev.twitter.com/docs/api/1.1/get/users/lookup
public static GetUsersDetailsFull ( this session, IEnumerable screenNames = null, IEnumerable userIds = null ) : Task>
session this
screenNames IEnumerable up to 100 are allowed in a single request.
userIds IEnumerable up to 100 are allowed in a single request.
return Task>

GetVerifyCredentials() public static method

Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.
public static GetVerifyCredentials ( this session ) : Task
session this
return Task

SearchForUsers() public static method

Provides a simple, relevance-based search interface to public user accounts on Twitter. Only the first 1,000 matching results are available.
ref: https://dev.twitter.com/docs/api/1.1/get/users/search
public static SearchForUsers ( this session, string searchQuery, int count = 20, int page = 1 ) : Task>
session this
searchQuery string The search query to run against people search.
count int The number of potential user results to retrieve per page. This value has a maximum of 20.
page int Specifies the page of results to retrieve.
return Task>