Method Summary
Public Methods | ||
public |
Make a DELETE request to delete this feed item resource through the REST API. |
|
public |
getComment(id: number, timeout: number): Promise<Comment> Get a feed comment given its id. |
|
public |
getComments(searchParams: Object, timeout: number): Promise<CommentList> Fetch a list of comments associated to this feed from the REST API. |
|
public |
getFolder(timeout: number): Promise<FileBrowserFolder> Fetch the folder associated to this feed from the REST API. |
|
public |
Fetch the note associated to this feed from the REST API. |
|
public |
getPluginInstances(params: Object, timeout: number): Promise<FeedPluginInstanceList> Fetch a list of plugin instances associated to this feed from the REST API. |
|
public |
getTaggings(params: Object, timeout: number): Promise<FeedTaggingList> Fetch a list of taggings associated to this feed from the REST API. |
|
public |
getTags(params: Object, timeout: number): Promise<FeedTagList> Fetch a list of tags associated to this feed from the REST API. |
|
public |
Make a PUT request to modify this feed item resource through the REST API. |
|
public |
Tag the feed given the id of the tag. |
Inherited Summary
From class Resource | ||
public static |
Helper method to make a deep copy clone of the passed object resource. |
|
public get |
Return true if the resource object contains any data. |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
Make a deep copy clone of this object resource. |
From class ItemResource | ||
public get |
Get the item's data object (REST API descriptors). |
|
public |
collection: * |
|
public |
Fetch this item resource from the REST API. |
|
public |
getPUTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in PUT requests. |
|
private |
Internal helper method to make a DELETE request to this item resource through the REST API. |
|
private |
_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Promise<ResourceClass> Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object. |
|
private |
Internal helper method to make a PUT request to this item resource through the REST API. |
Public Methods
public delete(timeout: number): Promise source
Make a DELETE request to delete this feed item resource through the REST API.
Params:
Name | Type | Attribute | Description |
timeout | number |
|
request timeout |
public getComment(id: number, timeout: number): Promise<Comment> source
Get a feed comment given its id.
public getComments(searchParams: Object, timeout: number): Promise<CommentList> source
Fetch a list of comments associated to this feed from the REST API.
Params:
Name | Type | Attribute | Description |
searchParams | Object |
|
search parameters object |
searchParams.limit | number |
|
page limit |
searchParams.offset | number |
|
page offset |
searchParams.id | number |
|
match comment id exactly with this number |
timeout | number |
|
request timeout |
public getFolder(timeout: number): Promise<FileBrowserFolder> source
Fetch the folder associated to this feed from the REST API.
Params:
Name | Type | Attribute | Description |
timeout | number |
|
request timeout |
public getNote(timeout: number): Promise<Note> source
Fetch the note associated to this feed from the REST API.
Params:
Name | Type | Attribute | Description |
timeout | number |
|
request timeout |
public getPluginInstances(params: Object, timeout: number): Promise<FeedPluginInstanceList> source
Fetch a list of plugin instances associated to this feed from the REST API.
public getTaggings(params: Object, timeout: number): Promise<FeedTaggingList> source
Fetch a list of taggings associated to this feed from the REST API.
public getTags(params: Object, timeout: number): Promise<FeedTagList> source
Fetch a list of tags associated to this feed from the REST API.
public put(data: Object, timeout: number): Promise<this> source
Make a PUT request to modify this feed item resource through the REST API.
Params:
Name | Type | Attribute | Description |
data | Object | request JSON data object |
|
data.name | string |
|
name of the feed |
data.public | boolean |
|
public status of the feed |
data.owner | string |
|
username to be added to the list of this feed's owners |
timeout | number |
|
request timeout |