C# Class Kippt.KipptClip

Mostrar archivo Open project: Haythem/Kippt.NET

Private Properties

Property Type Description

Public Methods

Method Description
AddComment ( KipptClient client, int clipId, string commentText ) : KipptComment

Add comment to a clip.
AddCommentAsync ( KipptClient client, int clipId, string commentText ) : void

Add comment to a clip.
Create ( KipptClient client ) : KipptClip

Creates a clip.

* Url (required). * Title (optional). * Notes (optional). * Resource uri of a list (otherwise it will be saved to inbox). * Is starred (optional). * Is read later (optional).

CreateAsync ( KipptClient client ) : void

Creates a clip.

* Url (required). * Title (optional). * Notes (optional). * Resource uri of a list (otherwise it will be saved to inbox). * Is starred (optional). * Is read later (optional).

Delete ( KipptClient client ) : void

Deletes a clip.
DeleteAsync ( KipptClient client ) : void

Deletes a clip.
DeleteComment ( KipptClient client, int clipId, int commentId ) : void

Delete a comment.
DeleteCommentAsync ( KipptClient client, int clipId, int commentId ) : void

Delete a comment.
FavoriteClip ( KipptClient client, int clipId ) : void

Add clip to favorites.
FavoriteClipAsync ( KipptClient client, int clipId ) : void

Add clip to favorites.
GetClip ( KipptClient client, int id ) : KipptClip

Returns a clip by its id.
GetClipAsync ( KipptClient client, int id ) : void

Returns a clip by its id.
GetClips ( KipptClient client, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection

Returns a collection of clips.

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

GetClips ( KipptClient client, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection

Returns a collection of clips.
GetClips ( KipptClient client, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection

Returns a collection of clips.
GetClipsAsync ( KipptClient client, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void

Returns a collection of clips.

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

GetClipsAsync ( KipptClient client, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void

Returns a collection of clips.
GetClipsAsync ( KipptClient client, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void

Returns a collection of clips.
GetClipsByList ( KipptClient client, int list, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection

Returns a collection of clips in a specific list.

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

GetClipsByList ( KipptClient client, int list, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection

Returns a collection of clips in a specific list.
GetClipsByList ( KipptClient client, int list, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection

Returns a collection of clips in a specific list.
GetClipsByListAsync ( KipptClient client, int list, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void

Returns a collection of clips in a specific list.

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

GetClipsByListAsync ( KipptClient client, int list, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void

Returns a collection of clips in a specific list.
GetClipsByListAsync ( KipptClient client, int list, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void

Returns a collection of clips in a specific list.
GetFavoriteClips ( KipptClient client, int limit, int offset, System.DateTime since = null ) : KipptClipCollection

Returns favorites clips. Both private and public.
GetFavoriteClipsAsync ( KipptClient client, int limit, int offset, System.DateTime since = null ) : void

Returns favorites clips. Both private and public.
GetFeed ( KipptClient client ) : KipptClipCollection

Returns a collection of feed items.
GetFeed ( KipptClient client, int limit ) : KipptClipCollection

Returns a collection of feed items.
GetFeed ( KipptClient client, int limit, int offset ) : KipptClipCollection

Returns a collection of feed items.
GetFeedAsync ( KipptClient client ) : void

Returns a collection of feed items.
GetFeedAsync ( KipptClient client, int limit ) : void

Returns a collection of feed items.
GetFeedAsync ( KipptClient client, int limit, int offset ) : void

Returns a collection of feed items.
LikeClip ( KipptClient client, int clipId ) : void

Like clip.
LikeClipAsync ( KipptClient client, int clipId ) : void

Like clip.
Search ( KipptClient client, string query, int list = null, bool isStarred = false ) : KipptClipCollection

Returns a query filtered collection of clips.

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

Search ( KipptClient client, string query, int limit, int list = null, bool isStarred = false ) : KipptClipCollection

Returns a query filtered collection of clips.
Search ( KipptClient client, string query, int limit, int offset, int list = null, bool isStarred = false ) : KipptClipCollection

Returns a query filtered collection of clips.
SearchAsync ( KipptClient client, string query, int list = null, bool isStarred = false ) : void

Returns a query filtered collection of clips.

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

SearchAsync ( KipptClient client, string query, int limit, int list = null, bool isStarred = false ) : void

Returns a query filtered collection of clips.
SearchAsync ( KipptClient client, string query, int limit, int offset, int list = null, bool isStarred = false ) : void

Returns a query filtered collection of clips.
UnFavoriteClip ( KipptClient client, int clipId ) : void

Remove clip from favorites.
UnFavoriteClipAsync ( KipptClient client, int clipId ) : void

Remove clip from favorites.
UnLikeClip ( KipptClient client, int clipId ) : void

Unlike a clip.
UnLikeClipAsync ( KipptClient client, int clipId ) : void

Unlike a clip.
Update ( KipptClient client ) : KipptClip

Updates a clip.
UpdateAsync ( KipptClient client ) : void

Updates a clip.

Method Details

AddComment() public static method

Add comment to a clip.
public static AddComment ( KipptClient client, int clipId, string commentText ) : KipptComment
client KipptClient instance.
clipId int Clip id.
commentText string Comment text.
return KipptComment

AddCommentAsync() public static method

Add comment to a clip.
public static AddCommentAsync ( KipptClient client, int clipId, string commentText ) : void
client KipptClient instance.
clipId int Clip id.
commentText string Comment text.
return void

Create() public method

Creates a clip.
* Url (required). * Title (optional). * Notes (optional). * Resource uri of a list (otherwise it will be saved to inbox). * Is starred (optional). * Is read later (optional).
public Create ( KipptClient client ) : KipptClip
client KipptClient instance.
return KipptClip

CreateAsync() public method

Creates a clip.
* Url (required). * Title (optional). * Notes (optional). * Resource uri of a list (otherwise it will be saved to inbox). * Is starred (optional). * Is read later (optional).
public CreateAsync ( KipptClient client ) : void
client KipptClient instance.
return void

Delete() public method

Deletes a clip.
public Delete ( KipptClient client ) : void
client KipptClient instance.
return void

DeleteAsync() public method

Deletes a clip.
public DeleteAsync ( KipptClient client ) : void
client KipptClient instance.
return void

DeleteComment() public static method

Delete a comment.
public static DeleteComment ( KipptClient client, int clipId, int commentId ) : void
client KipptClient instance.
clipId int clip id.
commentId int comment id.
return void

DeleteCommentAsync() public static method

Delete a comment.
public static DeleteCommentAsync ( KipptClient client, int clipId, int commentId ) : void
client KipptClient instance.
clipId int clip id.
commentId int comment id.
return void

FavoriteClip() public static method

Add clip to favorites.
public static FavoriteClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

FavoriteClipAsync() public static method

Add clip to favorites.
public static FavoriteClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

GetClip() public static method

Returns a clip by its id.
public static GetClip ( KipptClient client, int id ) : KipptClip
client KipptClient instance.
id int Clip id.
return KipptClip

GetClipAsync() public static method

Returns a clip by its id.
public static GetClipAsync ( KipptClient client, int id ) : void
client KipptClient instance.
id int Clip id.
return void

GetClips() public static method

Returns a collection of clips.
Results are paginated. The default number of returned clips is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static GetClips ( KipptClient client, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return KipptClipCollection

GetClips() public static method

Returns a collection of clips.
public static GetClips ( KipptClient client, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
limit int End index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return KipptClipCollection

GetClips() public static method

Returns a collection of clips.
public static GetClips ( KipptClient client, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
limit int End index.
offset int Start index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return KipptClipCollection

GetClipsAsync() public static method

Returns a collection of clips.
Results are paginated. The default number of returned clips is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static GetClipsAsync ( KipptClient client, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void
client KipptClient instance.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return void

GetClipsAsync() public static method

Returns a collection of clips.
public static GetClipsAsync ( KipptClient client, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void
client KipptClient instance.
limit int End index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return void

GetClipsAsync() public static method

Returns a collection of clips.
public static GetClipsAsync ( KipptClient client, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void
client KipptClient instance.
limit int End index.
offset int Start index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return void

GetClipsByList() public static method

Returns a collection of clips in a specific list.
Results are paginated. The default number of returned clips is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static GetClipsByList ( KipptClient client, int list, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
list int List id.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return KipptClipCollection

GetClipsByList() public static method

Returns a collection of clips in a specific list.
public static GetClipsByList ( KipptClient client, int list, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
list int List id.
limit int End index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return KipptClipCollection

GetClipsByList() public static method

Returns a collection of clips in a specific list.
public static GetClipsByList ( KipptClient client, int list, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
list int List id.
limit int End index.
offset int Start index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return KipptClipCollection

GetClipsByListAsync() public static method

Returns a collection of clips in a specific list.
Results are paginated. The default number of returned clips is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static GetClipsByListAsync ( KipptClient client, int list, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void
client KipptClient instance.
list int List id.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return void

GetClipsByListAsync() public static method

Returns a collection of clips in a specific list.
public static GetClipsByListAsync ( KipptClient client, int list, int limit, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void
client KipptClient instance.
list int List id.
limit int End index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return void

GetClipsByListAsync() public static method

Returns a collection of clips in a specific list.
public static GetClipsByListAsync ( KipptClient client, int list, int limit, int offset, bool isStarred = false, bool isReadLater = false, System.DateTime since = null ) : void
client KipptClient instance.
list int List id.
limit int End index.
offset int Start index.
isStarred bool Filter clips by returning only starred ones.
isReadLater bool Filter clips returning only read later ones.
since System.DateTime Specify a start date as a filter.
return void

GetFavoriteClips() public static method

Returns favorites clips. Both private and public.
public static GetFavoriteClips ( KipptClient client, int limit, int offset, System.DateTime since = null ) : KipptClipCollection
client KipptClient instance.
limit int End index.
offset int Start index.
since System.DateTime Date filter.
return KipptClipCollection

GetFavoriteClipsAsync() public static method

Returns favorites clips. Both private and public.
public static GetFavoriteClipsAsync ( KipptClient client, int limit, int offset, System.DateTime since = null ) : void
client KipptClient instance.
limit int End index.
offset int Start index.
since System.DateTime Date filter.
return void

GetFeed() public static method

Returns a collection of feed items.
public static GetFeed ( KipptClient client ) : KipptClipCollection
client KipptClient instance.
return KipptClipCollection

GetFeed() public static method

Returns a collection of feed items.
public static GetFeed ( KipptClient client, int limit ) : KipptClipCollection
client KipptClient instance.
limit int
return KipptClipCollection

GetFeed() public static method

Returns a collection of feed items.
public static GetFeed ( KipptClient client, int limit, int offset ) : KipptClipCollection
client KipptClient instance.
limit int End index.
offset int Start index.
return KipptClipCollection

GetFeedAsync() public static method

Returns a collection of feed items.
public static GetFeedAsync ( KipptClient client ) : void
client KipptClient instance.
return void

GetFeedAsync() public static method

Returns a collection of feed items.
public static GetFeedAsync ( KipptClient client, int limit ) : void
client KipptClient instance.
limit int
return void

GetFeedAsync() public static method

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

LikeClip() public static method

Like clip.
public static LikeClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

LikeClipAsync() public static method

Like clip.
public static LikeClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

Search() public static method

Returns a query filtered collection of clips.
Results are paginated. The default number of returned clips is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static Search ( KipptClient client, string query, int list = null, bool isStarred = false ) : KipptClipCollection
client KipptClient instance.
query string Query.
list int List id.
isStarred bool Filter clips by returning only starred ones.
return KipptClipCollection

Search() public static method

Returns a query filtered collection of clips.
public static Search ( KipptClient client, string query, int limit, int list = null, bool isStarred = false ) : KipptClipCollection
client KipptClient instance.
query string Query.
limit int End index.
list int List id.
isStarred bool Filter clips by returning only starred ones.
return KipptClipCollection

Search() public static method

Returns a query filtered collection of clips.
public static Search ( KipptClient client, string query, int limit, int offset, int list = null, bool isStarred = false ) : KipptClipCollection
client KipptClient instance.
query string Query.
limit int End index.
offset int Start index.
list int List id.
isStarred bool Filter clips by returning only starred ones.
return KipptClipCollection

SearchAsync() public static method

Returns a query filtered collection of clips.
Results are paginated. The default number of returned clips is 20. Pagination information are stored in the Meta property of KipptListCollection class.
public static SearchAsync ( KipptClient client, string query, int list = null, bool isStarred = false ) : void
client KipptClient instance.
query string Query.
list int List id.
isStarred bool Filter clips by returning only starred ones.
return void

SearchAsync() public static method

Returns a query filtered collection of clips.
public static SearchAsync ( KipptClient client, string query, int limit, int list = null, bool isStarred = false ) : void
client KipptClient instance.
query string Query.
limit int End index.
list int List id.
isStarred bool Filter clips by returning only starred ones.
return void

SearchAsync() public static method

Returns a query filtered collection of clips.
public static SearchAsync ( KipptClient client, string query, int limit, int offset, int list = null, bool isStarred = false ) : void
client KipptClient instance.
query string Query.
limit int End index.
offset int Start index.
list int List id.
isStarred bool Filter clips by returning only starred ones.
return void

UnFavoriteClip() public static method

Remove clip from favorites.
public static UnFavoriteClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

UnFavoriteClipAsync() public static method

Remove clip from favorites.
public static UnFavoriteClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

UnLikeClip() public static method

Unlike a clip.
public static UnLikeClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

UnLikeClipAsync() public static method

Unlike a clip.
public static UnLikeClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
return void

Update() public method

Updates a clip.
public Update ( KipptClient client ) : KipptClip
client KipptClient instance.
return KipptClip

UpdateAsync() public method

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