C# Класс Kippt.KipptClip

Показать файл Открыть проект

Private Properties

Свойство Тип Описание

Открытые методы

Метод Описание
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.

Описание методов

AddComment() публичный статический Метод

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.
Результат KipptComment

AddCommentAsync() публичный статический Метод

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.
Результат void

Create() публичный Метод

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.
Результат KipptClip

CreateAsync() публичный Метод

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.
Результат void

Delete() публичный Метод

Deletes a clip.
public Delete ( KipptClient client ) : void
client KipptClient instance.
Результат void

DeleteAsync() публичный Метод

Deletes a clip.
public DeleteAsync ( KipptClient client ) : void
client KipptClient instance.
Результат void

DeleteComment() публичный статический Метод

Delete a comment.
public static DeleteComment ( KipptClient client, int clipId, int commentId ) : void
client KipptClient instance.
clipId int clip id.
commentId int comment id.
Результат void

DeleteCommentAsync() публичный статический Метод

Delete a comment.
public static DeleteCommentAsync ( KipptClient client, int clipId, int commentId ) : void
client KipptClient instance.
clipId int clip id.
commentId int comment id.
Результат void

FavoriteClip() публичный статический Метод

Add clip to favorites.
public static FavoriteClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

FavoriteClipAsync() публичный статический Метод

Add clip to favorites.
public static FavoriteClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

GetClip() публичный статический Метод

Returns a clip by its id.
public static GetClip ( KipptClient client, int id ) : KipptClip
client KipptClient instance.
id int Clip id.
Результат KipptClip

GetClipAsync() публичный статический Метод

Returns a clip by its id.
public static GetClipAsync ( KipptClient client, int id ) : void
client KipptClient instance.
id int Clip id.
Результат void

GetClips() публичный статический Метод

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.
Результат KipptClipCollection

GetClips() публичный статический Метод

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.
Результат KipptClipCollection

GetClips() публичный статический Метод

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.
Результат KipptClipCollection

GetClipsAsync() публичный статический Метод

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.
Результат void

GetClipsAsync() публичный статический Метод

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.
Результат void

GetClipsAsync() публичный статический Метод

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.
Результат void

GetClipsByList() публичный статический Метод

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.
Результат KipptClipCollection

GetClipsByList() публичный статический Метод

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.
Результат KipptClipCollection

GetClipsByList() публичный статический Метод

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.
Результат KipptClipCollection

GetClipsByListAsync() публичный статический Метод

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.
Результат void

GetClipsByListAsync() публичный статический Метод

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.
Результат void

GetClipsByListAsync() публичный статический Метод

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.
Результат void

GetFavoriteClips() публичный статический Метод

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.
Результат KipptClipCollection

GetFavoriteClipsAsync() публичный статический Метод

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.
Результат void

GetFeed() публичный статический Метод

Returns a collection of feed items.
public static GetFeed ( KipptClient client ) : KipptClipCollection
client KipptClient instance.
Результат KipptClipCollection

GetFeed() публичный статический Метод

Returns a collection of feed items.
public static GetFeed ( KipptClient client, int limit ) : KipptClipCollection
client KipptClient instance.
limit int
Результат KipptClipCollection

GetFeed() публичный статический Метод

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.
Результат KipptClipCollection

GetFeedAsync() публичный статический Метод

Returns a collection of feed items.
public static GetFeedAsync ( KipptClient client ) : void
client KipptClient instance.
Результат void

GetFeedAsync() публичный статический Метод

Returns a collection of feed items.
public static GetFeedAsync ( KipptClient client, int limit ) : void
client KipptClient instance.
limit int
Результат void

GetFeedAsync() публичный статический Метод

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.
Результат void

LikeClip() публичный статический Метод

Like clip.
public static LikeClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

LikeClipAsync() публичный статический Метод

Like clip.
public static LikeClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

Search() публичный статический Метод

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.
Результат KipptClipCollection

Search() публичный статический Метод

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.
Результат KipptClipCollection

Search() публичный статический Метод

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.
Результат KipptClipCollection

SearchAsync() публичный статический Метод

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.
Результат void

SearchAsync() публичный статический Метод

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.
Результат void

SearchAsync() публичный статический Метод

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.
Результат void

UnFavoriteClip() публичный статический Метод

Remove clip from favorites.
public static UnFavoriteClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

UnFavoriteClipAsync() публичный статический Метод

Remove clip from favorites.
public static UnFavoriteClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

UnLikeClip() публичный статический Метод

Unlike a clip.
public static UnLikeClip ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

UnLikeClipAsync() публичный статический Метод

Unlike a clip.
public static UnLikeClipAsync ( KipptClient client, int clipId ) : void
client KipptClient instance.
clipId int Clip id.
Результат void

Update() публичный Метод

Updates a clip.
public Update ( KipptClient client ) : KipptClip
client KipptClient instance.
Результат KipptClip

UpdateAsync() публичный Метод

Updates a clip.
public UpdateAsync ( KipptClient client ) : void
client KipptClient instance.
Результат void