C# Class Kippt.KipptList

Datei anzeigen Open project: Haythem/Kippt.NET

Private Properties

Property Type Description

Public Methods

Method Description
Create ( KipptClient client ) : KipptList

Creates a list.

* Title (required).

CreateAsync ( KipptClient client ) : void

Creates a list.

* Title (required).

Delete ( KipptClient client ) : void

Deleted a list.

DeleteAsync ( KipptClient client ) : void

Deleted a list.

FollowList ( KipptClient client, int listId ) : void

Follow a list.

FollowListAsync ( KipptClient client, int listId ) : void

Follow a list.

GetList ( KipptClient client, int id ) : KipptList

Returns a list by its id.

GetListAsync ( KipptClient client, int id ) : void

Returns a list by its id.

GetListFollowings ( KipptClient client, int listId, int limit, int offset ) : KipptUserCollection

Returns list of users following a list.

GetListFollowingsAsync ( KipptClient client, int listId, int limit, int offset ) : void

Returns list of users following a list.

GetLists ( KipptClient client ) : KipptListCollection

Returns a collection of lists.

Results are paginated. The default number of returned lists is 20. Pagination information are stored in the Meta property of KipptListCollection class.

GetLists ( KipptClient client, int limit ) : KipptListCollection

Returns a collection of lists.

GetLists ( KipptClient client, int limit, int offset ) : KipptListCollection

Returns a collection of lists.

GetListsAsync ( KipptClient client ) : void

Returns a collection of lists.

Results are paginated. The default number of returned lists is 20. Pagination information are stored in the Meta property of KipptListCollection class.

GetListsAsync ( KipptClient client, int limit ) : void

Returns a collection of lists.

GetListsAsync ( KipptClient client, int limit, int offset ) : void

Returns a collection of lists.

GetUserLists ( KipptClient client, int userId, int limit, int offset ) : KipptListCollection

Returns lists of a user

GetUserListsAsync ( KipptClient client, int userId, int limit, int offset ) : void

Returns lists of a user

IsFollowing ( KipptClient client, int listId ) : bool

Checks whether the logged in user is following a list.

IsFollowingAsync ( KipptClient client, int listId ) : void

Checks whether the logged in user is following a list.

Search ( KipptClient client, string query, int limit, int offset ) : KipptListCollection

Search for a list.

SearchAsync ( KipptClient client, string query, int limit, int offset ) : void

Search for a list.

UnFollowList ( KipptClient client, int listId ) : void

Unfollow a list.

UnFollowListAsync ( KipptClient client, int listId ) : void

Unfollow a list.

Update ( KipptClient client ) : KipptList

Updates a list.

UpdateAsync ( KipptClient client ) : void

Updates a list.

Method Details

Create() public method

Creates a list.
* Title (required).
public Create ( KipptClient client ) : KipptList
client KipptClient instance.
return KipptList

CreateAsync() public method

Creates a list.
* Title (required).
public CreateAsync ( KipptClient client ) : void
client KipptClient instance.
return void

Delete() public method

Deleted a list.
public Delete ( KipptClient client ) : void
client KipptClient instance.
return void

DeleteAsync() public method

Deleted a list.
public DeleteAsync ( KipptClient client ) : void
client KipptClient instance.
return void

FollowList() public static method

Follow a list.
public static FollowList ( KipptClient client, int listId ) : void
client KipptClient instance.
listId int List id.
return void

FollowListAsync() public static method

Follow a list.
public static FollowListAsync ( KipptClient client, int listId ) : void
client KipptClient instance.
listId int List id.
return void

GetList() public static method

Returns a list by its id.
public static GetList ( KipptClient client, int id ) : KipptList
client KipptClient instance.
id int List id.
return KipptList

GetListAsync() public static method

Returns a list by its id.
public static GetListAsync ( KipptClient client, int id ) : void
client KipptClient instance.
id int List id.
return void

GetListFollowings() public static method

Returns list of users following a list.
public static GetListFollowings ( KipptClient client, int listId, int limit, int offset ) : KipptUserCollection
client KipptClient instance.
listId int List id.
limit int End index.
offset int Start index.
return KipptUserCollection

GetListFollowingsAsync() public static method

Returns list of users following a list.
public static GetListFollowingsAsync ( KipptClient client, int listId, int limit, int offset ) : void
client KipptClient instance.
listId int List id.
limit int End index.
offset int Start index.
return void

GetLists() public static method

Returns a collection of lists.
Results are paginated. The default number of returned lists is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static GetLists ( KipptClient client ) : KipptListCollection
client KipptClient instance.
return KipptListCollection

GetLists() public static method

Returns a collection of lists.
public static GetLists ( KipptClient client, int limit ) : KipptListCollection
client KipptClient instance.
limit int End index.
return KipptListCollection

GetLists() public static method

Returns a collection of lists.
public static GetLists ( KipptClient client, int limit, int offset ) : KipptListCollection
client KipptClient instance.
limit int End index.
offset int Start index.
return KipptListCollection

GetListsAsync() public static method

Returns a collection of lists.
Results are paginated. The default number of returned lists is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static GetListsAsync ( KipptClient client ) : void
client KipptClient instance.
return void

GetListsAsync() public static method

Returns a collection of lists.
public static GetListsAsync ( KipptClient client, int limit ) : void
client KipptClient instance.
limit int End index.
return void

GetListsAsync() public static method

Returns a collection of lists.
public static GetListsAsync ( KipptClient client, int limit, int offset ) : void
client KipptClient instance.
limit int End index.
offset int Start index.
return void

GetUserLists() public static method

Returns lists of a user
public static GetUserLists ( KipptClient client, int userId, int limit, int offset ) : KipptListCollection
client KipptClient instance.
userId int User id.
limit int End index.
offset int Start index.
return KipptListCollection

GetUserListsAsync() public static method

Returns lists of a user
public static GetUserListsAsync ( KipptClient client, int userId, int limit, int offset ) : void
client KipptClient instance.
userId int User id.
limit int End index.
offset int Start index.
return void

IsFollowing() public static method

Checks whether the logged in user is following a list.
public static IsFollowing ( KipptClient client, int listId ) : bool
client KipptClient instance.
listId int List id.
return bool

IsFollowingAsync() public static method

Checks whether the logged in user is following a list.
public static IsFollowingAsync ( KipptClient client, int listId ) : void
client KipptClient instance.
listId int List id.
return void

Search() public static method

Search for a list.
public static Search ( KipptClient client, string query, int limit, int offset ) : KipptListCollection
client KipptClient instance.
query string Query.
limit int End index.
offset int Start index.
return KipptListCollection

SearchAsync() public static method

Search for a list.
public static SearchAsync ( KipptClient client, string query, int limit, int offset ) : void
client KipptClient instance.
query string Query.
limit int End index.
offset int Start index.
return void

UnFollowList() public static method

Unfollow a list.
public static UnFollowList ( KipptClient client, int listId ) : void
client KipptClient instance.
listId int List id.
return void

UnFollowListAsync() public static method

Unfollow a list.
public static UnFollowListAsync ( KipptClient client, int listId ) : void
client KipptClient instance.
listId int List id.
return void

Update() public method

Updates a list.
public Update ( KipptClient client ) : KipptList
client KipptClient instance.
return KipptList

UpdateAsync() public method

Updates a list.
public UpdateAsync ( KipptClient client ) : void
client KipptClient instance.
return void