Interface Feed

Feed item resource object representing a feed.

interface Feed {
    auth: Object;
    collection: Object | null;
    contentType: string;
    url: string;
    get data(): Object | null;
    get isEmpty(): boolean;
    _delete(timeout?: number): Promise<any>;
    _getResource(
        linkRelation: string,
        ResourceClass: Object,
        searchParams?: { limit?: number; offset?: number },
        timeout?: number,
    ): Promise<Object>;
    _put(
        data: Object,
        uploadFileObj: Object | null,
        timeout?: number,
    ): Promise<Feed>;
    addComment(
        title?: string,
        content?: string,
        timeout?: number,
    ): Promise<Comment>;
    addGroupPermission(
        group_name: string,
        timeout?: number,
    ): Promise<FeedGroupPermission>;
    addTagging(tag_id: number, timeout?: number): Promise<Tagging>;
    addUserPermission(
        username: string,
        timeout?: number,
    ): Promise<FeedUserPermission>;
    clone(): Resource;
    delete(timeout?: number): Promise<any>;
    get(timeout?: number): Promise<Feed>;
    getComment(id: number, timeout?: number): Promise<Comment>;
    getComments(
        searchParams?: { id?: number; limit?: number; offset?: number },
        timeout?: number,
    ): Promise<CommentList>;
    getFolder(timeout?: number): Promise<FileBrowserFolder>;
    getGroupPermission(
        group_name: string,
        timeout?: number,
    ): Promise<FeedGroupPermission | null>;
    getGroupPermissions(
        searchParams?: {
            group_name?: string;
            id?: number;
            limit?: number;
            offset?: number;
        },
        timeout?: number,
    ): Promise<FeedGroupPermissionList>;
    getNote(timeout?: number): Promise<Note>;
    getPluginInstances(
        params?: { limit?: number; offset?: number },
        timeout?: number,
    ): Promise<FeedPluginInstanceList>;
    getPUTParameters(): string[] | null;
    getTaggings(
        params?: { limit?: number; offset?: number },
        timeout?: number,
    ): Promise<FeedTaggingList>;
    getTags(
        params?: { limit?: number; offset?: number },
        timeout?: number,
    ): Promise<FeedTagList>;
    getUserPermission(
        username: string,
        timeout?: number,
    ): Promise<FeedUserPermission | null>;
    getUserPermissions(
        searchParams?: {
            id?: number;
            limit?: number;
            offset?: number;
            username?: string;
        },
        timeout?: number,
    ): Promise<FeedUserPermissionList>;
    makePublic(timeout?: number): Promise<Feed>;
    makeUnpublic(timeout?: number): Promise<Feed>;
    put(
        data: { name?: string; public?: boolean },
        timeout?: number,
    ): Promise<Feed>;
}

Hierarchy (View Summary)

ItemResource
- Feed

Properties

auth

auth: Object

collection

collection: Object | null

contentType

contentType: string

url

url: string

Accessors

data

get data(): Object | null
Get the item's data object (REST API descriptors).

Returns Object | null
Inherited from ItemResource.data
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:64

isEmpty

get isEmpty(): boolean
Return true if the resource object contains any data.

Returns boolean
Inherited from ItemResource.isEmpty
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:39

Methods

_delete

_delete(timeout?: number): Promise<any>
Internal helper method to make a DELETE request to this item resource through the REST API.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<any>
- JS Promise
Inherited from ItemResource._delete
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:118

_getResource

_getResource(
    linkRelation: string,
    ResourceClass: Object,
    searchParams?: { limit?: number; offset?: number },
    timeout?: number,
): Promise<Object>
Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.
Parameters
- linkRelation: string
- ResourceClass: Object
- OptionalsearchParams: { limit?: number; offset?: number }
  search parameters object which is resource-specific
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
- Optionaltimeout: number
  request timeout
Returns Promise<Object>
- JS Promise, resolves to a ResourceClass object
Throws
throw error if this item resource has not yet been fetched from the REST API

Throws
throw error when the link relation is not found
Inherited from ItemResource._getResource
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:89

_put

_put(
    data: Object,
    uploadFileObj: Object | null,
    timeout?: number,
): Promise<Feed>
Internal helper method to make a PUT request to this item resource through the REST API.
Parameters
- data: Object
  request JSON data object
- uploadFileObj: Object | null
  custom file object
  - Object
    
    fname
    
    file blob
  - null
- Optionaltimeout: number
  request timeout
Returns Promise<Feed>
- JS Promise, resolves to this object
Inherited from ItemResource._put
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:109

addComment

addComment(title?: string, content?: string, timeout?: number): Promise<Comment>
Add a new comment to the feed.
Parameters
- Optionaltitle: string
  title of the comment
- Optionalcontent: string
  content of the comment
- Optionaltimeout: number
  request timeout
Returns Promise<Comment>
- JS Promise, resolves to a Comment object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:178

addGroupPermission

addGroupPermission(
group_name: string,
timeout?: number,
): Promise<FeedGroupPermission>
Add a group permission to access the feed.
Parameters
- group_name: string
  group's name
- Optionaltimeout: number
  request timeout
Returns Promise<FeedGroupPermission>
- JS Promise, resolves to a FeedGroupPermission object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:203

addTagging

addTagging(tag_id: number, timeout?: number): Promise<Tagging>
Add a new tagging to the feed (tag the feed) given the id of the tag.
Parameters
- tag_id: number
  tag id
- Optionaltimeout: number
  request timeout
Returns Promise<Tagging>
- JS Promise, resolves to a Tagging object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:168

addUserPermission

addUserPermission(
username: string,
timeout?: number,
): Promise<FeedUserPermission>
Add a user permission to access the feed.
Parameters
- username: string
  user's username
- Optionaltimeout: number
  request timeout
Returns Promise<FeedUserPermission>
- JS Promise, resolves to a FeedUserPermission object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:212

clone

clone(): Resource
Make a deep copy clone of this object resource.

Returns Resource
- clone object
Inherited from ItemResource.clone
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:45

delete

delete(timeout?: number): Promise<any>
Make a DELETE request to delete this feed item resource through the REST API.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<any>
- JS Promise
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:237

get

get(timeout?: number): Promise<Feed>
Fetch this item resource from the REST API.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<Feed>
- JS Promise, resolves to this object
Inherited from ItemResource.get
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:58

getComment

getComment(id: number, timeout?: number): Promise<Comment>
Get a feed comment given its id.
Parameters
- id: number
  comment id
- Optionaltimeout: number
  request timeout
Returns Promise<Comment>
- JS Promise, resolves to a Comment object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:142

getComments

getComments(
searchParams?: { id?: number; limit?: number; offset?: number },
timeout?: number,
): Promise<CommentList>
Fetch a list of comments associated to this feed from the REST API.
Parameters
- OptionalsearchParams: { id?: number; limit?: number; offset?: number }
  search parameters object
  - Optionalid?: number
    
    match comment id exactly with this number
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
- Optionaltimeout: number
  request timeout
Returns Promise<CommentList>
- JS Promise, resolves to a CommentList object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:126

getFolder

getFolder(timeout?: number): Promise<FileBrowserFolder>
Fetch the folder associated to this feed from the REST API.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<FileBrowserFolder>
- JS Promise, resolves to a FileBrowserFolder object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:12

getGroupPermission

getGroupPermission(
group_name: string,
timeout?: number,
): Promise<FeedGroupPermission | null>
Get a feed group permission given the name of the group.
Parameters
- group_name: string
  feed group permission's group name
- Optionaltimeout: number
  request timeout
Returns Promise<FeedGroupPermission | null>
- JS Promise, resolves to a FeedGroupPermission object or null
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:50

getGroupPermissions

getGroupPermissions(
    searchParams?: {
        group_name?: string;
        id?: number;
        limit?: number;
        offset?: number;
    },
    timeout?: number,
): Promise<FeedGroupPermissionList>
Fetch a list of group permissions associated to this feed from the REST API.
Parameters
- OptionalsearchParams: { group_name?: string; id?: number; limit?: number; offset?: number }
  search parameters object
  - Optionalgroup_name?: string
    
    match group name exactly with this string
  - Optionalid?: number
    
    match feed group permission id exactly with this number
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
- Optionaltimeout: number
  request timeout
Returns Promise<FeedGroupPermissionList>
- JS Promise, resolves to a FeedGroupPermissionList object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:33

getNote

getNote(timeout?: number): Promise<Note>
Fetch the note associated to this feed from the REST API.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<Note>
- JS Promise, resolves to a Note object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:20

getPluginInstances

getPluginInstances(
params?: { limit?: number; offset?: number },
timeout?: number,
): Promise<FeedPluginInstanceList>
Fetch a list of plugin instances associated to this feed from the REST API.
Parameters
- Optionalparams: { limit?: number; offset?: number }
  page parameters object
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
- Optionaltimeout: number
  request timeout
Returns Promise<FeedPluginInstanceList>
- JS Promise, resolves to a FeedPluginInstanceList object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:153

getPUTParameters

getPUTParameters(): string[] | null
Get an array of parameter names that can be used as properties of the data object in PUT requests.

Returns string[] | null
- array of PUT data property name or null if this list resource's data has not been fetched from the API yet or it doesn't support PUT requests.
Inherited from ItemResource.getPUTParameters
- Defined in node_modules/@fnndsc/chrisapi/dist/types/resource.d.ts:73

getTaggings

getTaggings(
params?: { limit?: number; offset?: number },
timeout?: number,
): Promise<FeedTaggingList>
Fetch a list of taggings associated to this feed from the REST API.
Parameters
- Optionalparams: { limit?: number; offset?: number }
  page parameters object
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
- Optionaltimeout: number
  request timeout
Returns Promise<FeedTaggingList>
- JS Promise, resolves to a FeedTaggingList object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:108

getTags

getTags(
params?: { limit?: number; offset?: number },
timeout?: number,
): Promise<FeedTagList>
Fetch a list of tags associated to this feed from the REST API.
Parameters
- Optionalparams: { limit?: number; offset?: number }
  page parameters object
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
- Optionaltimeout: number
  request timeout
Returns Promise<FeedTagList>
- JS Promise, resolves to a FeedTagList object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:91

getUserPermission

getUserPermission(
username: string,
timeout?: number,
): Promise<FeedUserPermission | null>
Get a feed user permission given the username of the user.
Parameters
- username: string
  feed user permission's username
- Optionaltimeout: number
  request timeout
Returns Promise<FeedUserPermission | null>
- JS Promise, resolves to a FeedUserPermission object or null
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:80

getUserPermissions

getUserPermissions(
    searchParams?: {
        id?: number;
        limit?: number;
        offset?: number;
        username?: string;
    },
    timeout?: number,
): Promise<FeedUserPermissionList>
Fetch a list of user permissions associated to this feed from the REST API.
Parameters
- OptionalsearchParams: { id?: number; limit?: number; offset?: number; username?: string }
  search parameters object
  - Optionalid?: number
    
    match feed user permission id exactly with this number
  - Optionallimit?: number
    
    page limit
  - Optionaloffset?: number
    
    page offset
  - Optionalusername?: string
    
    match username exactly with this string
- Optionaltimeout: number
  request timeout
Returns Promise<FeedUserPermissionList>
- JS Promise, resolves to a FeedUserPermissionList object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:63

makePublic

makePublic(timeout?: number): Promise<Feed>
Make the feed public.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<Feed>
- JS Promise, resolves to this object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:186

makeUnpublic

makeUnpublic(timeout?: number): Promise<Feed>
Make the feed unpublic.
Parameters
- Optionaltimeout: number
  request timeout
Returns Promise<Feed>
- JS Promise, resolves to this object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:194

put

put(data: { name?: string; public?: boolean }, timeout?: number): Promise<Feed>
Make a PUT request to modify this feed item resource through the REST API.
Parameters
- data: { name?: string; public?: boolean }
  request JSON data object
  - Optionalname?: string
    
    name of the feed
  - Optionalpublic?: boolean
    
    public status of the feed
- Optionaltimeout: number
  request timeout
Returns Promise<Feed>
- JS Promise, resolves to this object
- Defined in node_modules/@fnndsc/chrisapi/dist/types/feed.d.ts:223

Interface Feed

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

auth

collection

contentType

url

Accessors

data

Returns Object | null

isEmpty

Returns boolean

Methods

_delete

Parameters

Returns Promise<any>

_getResource

Parameters

Optionallimit?: number

Optionaloffset?: number

Returns Promise<Object>

Throws

Throws

_put

Parameters

fname

Returns Promise<Feed>

addComment

Parameters

Returns Promise<Comment>

addGroupPermission

Parameters

Returns Promise<FeedGroupPermission>

addTagging

Parameters

Returns Promise<Tagging>

addUserPermission

Parameters

Returns Promise<FeedUserPermission>

clone

Returns Resource

delete

Parameters

Returns Promise<any>

get

Parameters

Returns Promise<Feed>

getComment

Parameters

Returns Promise<Comment>

getComments

Parameters

Optionalid?: number

Optionallimit?: number

Optionaloffset?: number

Returns Promise<CommentList>

getFolder

Parameters

Returns Promise<FileBrowserFolder>

getGroupPermission

Parameters

Returns Promise<FeedGroupPermission | null>

getGroupPermissions

Parameters

Optionalgroup_name?: string

Optionalid?: number

Optionallimit?: number

Optionaloffset?: number

Returns Promise<FeedGroupPermissionList>

getNote

Parameters

Returns Promise<Note>

getPluginInstances

Parameters

Optionallimit?: number

Optionaloffset?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`id?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`group_name?: string

`Optional`id?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`id?: number

`Optional`limit?: number

`Optional`offset?: number

`Optional`username?: string

`Optional`name?: string

`Optional`public?: boolean