Home Reference Source
public class | source

BaseService

Direct Subclass:

application/redux/actions/acl-actions.js~AclService, ApiService, application/redux/actions/assignment-comment-actions.js~AssignmentCommentService, application/redux/actions/assignment-actions.js~AssignmentService, AssignmentService, application/redux/actions/author-actions.js~AuthorService, AuthorService, application/redux/actions/channel-actions.js~ChannelService, application/redux/actions/container-actions.js~ContainerService, ContainerService, application/redux/actions/content-search-actions.js~ContentSearchService, ContentService, application/redux/actions/content-actions.js~ContentService, application/redux/actions/content-version-actions.js~ContentVersionService, CopyNoteService, DraftService, application/redux/actions/entry-actions.js~EntryService, ErrorService, application/redux/actions/global-search-actions.js~GlobalSearchService, application/redux/actions/issue-actions.js~IssueService, NoteCommentService, application/redux/actions/note-comment-actions.js~NoteCommentService, application/redux/actions/application-actions.js~SettingService, application/redux/actions/site-actions.js~SiteService, application/redux/actions/ssts-actions.js~SstsService, TagService, application/redux/actions/tag-actions.js~TagService, application/components/common/simple-editor/service.js~UnwrappedService, application/redux/actions/user-actions.js~UserService, UserService, VersionService, application/redux/actions/workflow-section-actions.js~WorkflowSectionService, application/redux/actions/workflow-actions.js~WorkflowService

Services extend the base service to provide standard access methods.

Keep in mind that the API uses Basic Auth so the base service uses the CurrentUser object to fetch and encode the key

Method Summary

Public Methods
public

Preform a DELETE action

public

get(url: string, params: object): object

Preform a GET action

public

post(url: string, data: object, params: object): object

Preform a POST action

public

postUpload(url: string, data: object, params: object): object

Preform a POST action

public

put(url: string, data: object): object

Preform a PUT action

Public Methods

public delete(url: string): object source

Preform a DELETE action

Params:

NameTypeAttributeDescription
url string

URL

Return:

object

Immutable map or list

public get(url: string, params: object): object source

Preform a GET action

Params:

NameTypeAttributeDescription
url string

URL

params object

Key/value parameters

Return:

object

Immutable map or list

public post(url: string, data: object, params: object): object source

Preform a POST action

Params:

NameTypeAttributeDescription
url string

URL

data object

Key/value POST data

params object

Key/value GET data

Return:

object

Immutable map or list

public postUpload(url: string, data: object, params: object): object source

Preform a POST action

Params:

NameTypeAttributeDescription
url string

URL

data object

Key/value POST data

params object

Key/value GET data

Return:

object

Immutable map or list

public put(url: string, data: object): object source

Preform a PUT action

Params:

NameTypeAttributeDescription
url string

URL

data object

Key/value data

Return:

object

Immutable map or list