C# Class BoxKite.Twitter.FriendsFollowersExtensions

Show file Open project: nickhodge/BoxKite.Twitter

Public Methods

Method Description
ChangeFriendship ( this session, string screenName = "", int user_id, bool device = false, bool retweets = false ) : Task

Allows one to enable or disable retweets and device notifications from the specified user.

ref: https://dev.twitter.com/docs/api/1.1/post/friendships/update

CreateFriendship ( this session, string screenName = "", int user_id, bool follow = true ) : Task

Allows the authenticating users to follow the user specified.

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

DeleteFriendship ( this session, string screenName = "", int user_id ) : Task

Allows the authenticating users to follow the user specified.

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

GetFollowersIDs ( this session, string screenName = "", int userId, int count = 500, long cursor = -1 ) : Task

Returns a cursored collection of user IDs following a particular user(otherwise known as their "followers")

ref: https://dev.twitter.com/docs/api/1.1/get/followers/ids

GetFollowersList ( this session, string screenName = "", int userId, int count = 20, long cursor = -1 ) : Task

Returns a cursored collection of user objects for users following the specified user. Presently in most recent following first

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

GetFriendsIDs ( this session, string screenName = "", int userId, int count = 500, long cursor = -1 ) : Task

Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their "friends")

ref: https://dev.twitter.com/docs/api/1.1/get/friends/ids

GetFriendsList ( this session, string screenName = "", int userId, int count = 20, long cursor = -1 ) : Task

Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").

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

GetFriendship ( this session, string sourceScreenName = "", string targetScreenName = "", int sourceId, int targetId ) : Task

Returns detailed information about the relationship between two arbitrary users.

ref: https://api.twitter.com/1.1/friendships/show.json

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

Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.

ref: https://dev.twitter.com/docs/api/1.1/get/friendships/incoming

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

Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

ref: https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing

GetFriendships ( this session, IEnumerable screenNames = null, IEnumerable userIds = null ) : Task>

Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.

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

Method Details

ChangeFriendship() public static method

Allows one to enable or disable retweets and device notifications from the specified user.
ref: https://dev.twitter.com/docs/api/1.1/post/friendships/update
public static ChangeFriendship ( this session, string screenName = "", int user_id, bool device = false, bool retweets = false ) : Task
session this
screenName string The screen name of the user
user_id int The ID of the user
device bool Enable/disable device notifications from the target user.
retweets bool Enable/disable retweets from the target user.
return Task

CreateFriendship() public static method

Allows the authenticating users to follow the user specified.
ref: https://dev.twitter.com/docs/api/1.1/post/friendships/create
public static CreateFriendship ( this session, string screenName = "", int user_id, bool follow = true ) : Task
session this
screenName string The screen name of the user for whom to befriend.
user_id int The ID of the user for whom to befriend.
follow bool Enable notifications for the target user.
return Task

DeleteFriendship() public static method

Allows the authenticating users to follow the user specified.
ref: https://dev.twitter.com/docs/api/1.1/post/friendships/destroy
public static DeleteFriendship ( this session, string screenName = "", int user_id ) : Task
session this
screenName string The screen name of the user for whom to un-befriend.
user_id int The ID of the user for whom to un-befriend.
return Task

GetFollowersIDs() public static method

Returns a cursored collection of user IDs following a particular user(otherwise known as their "followers")
ref: https://dev.twitter.com/docs/api/1.1/get/followers/ids
public static GetFollowersIDs ( this session, string screenName = "", int userId, int count = 500, long cursor = -1 ) : Task
session this
screenName string screen_name or user_id must be provided
userId int screen_name or user_id must be provided
count int how many to return default 500
cursor long default is first page (-1) otherwise provide starting point
return Task

GetFollowersList() public static method

Returns a cursored collection of user objects for users following the specified user. Presently in most recent following first
ref: https://dev.twitter.com/docs/api/1.1/get/followers/list
public static GetFollowersList ( this session, string screenName = "", int userId, int count = 20, long cursor = -1 ) : Task
session this
screenName string screen_name or user_id must be provided
userId int screen_name or user_id must be provided
count int how many to return default 500
cursor long default is first page (-1) otherwise provide starting point
return Task

GetFriendsIDs() public static method

Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their "friends")
ref: https://dev.twitter.com/docs/api/1.1/get/friends/ids
public static GetFriendsIDs ( this session, string screenName = "", int userId, int count = 500, long cursor = -1 ) : Task
session this
screenName string screen_name or user_id must be provided
userId int screen_name or user_id must be provided
count int how many to return default 500
cursor long default is first page (-1) otherwise provide starting point
return Task

GetFriendsList() public static method

Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
ref: https://dev.twitter.com/docs/api/1.1/get/friends/list
public static GetFriendsList ( this session, string screenName = "", int userId, int count = 20, long cursor = -1 ) : Task
session this
screenName string screen_name or user_id must be provided
userId int screen_name or user_id must be provided
count int how many to return default 500
cursor long default is first page (-1) otherwise provide starting point
return Task

GetFriendship() public static method

Returns detailed information about the relationship between two arbitrary users.
ref: https://api.twitter.com/1.1/friendships/show.json
public static GetFriendship ( this session, string sourceScreenName = "", string targetScreenName = "", int sourceId, int targetId ) : Task
session this
sourceScreenName string The user_id of the subject user.
targetScreenName string The screen_name of the target user.
sourceId int The screen_name of the subject user.
targetId int The user_id of the target user.
return Task

GetFriendshipRequestsIncoming() public static method

Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.
ref: https://dev.twitter.com/docs/api/1.1/get/friendships/incoming
public static GetFriendshipRequestsIncoming ( this session, long cursor = -1 ) : Task
session this
cursor long default is first page (-1) otherwise provide starting point
return Task

GetFriendshipRequestsOutgoing() public static method

Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
ref: https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing
public static GetFriendshipRequestsOutgoing ( this session, long cursor = -1 ) : Task
session this
cursor long default is first page (-1) otherwise provide starting point
return Task

GetFriendships() public static method

Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
ref : https://dev.twitter.com/docs/api/1.1/get/friendships/lookup
public static GetFriendships ( this session, IEnumerable screenNames = null, IEnumerable userIds = null ) : Task>
session this
screenNames IEnumerable list of screen_names to check
userIds IEnumerable list of user_ids to check against
return Task>