Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DigitalMessageNoteService

Service to handle message notes

Hierarchy

  • DigitalMessageNoteService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private CREATE_NOTE

CREATE_NOTE: string = '/dfo/3.0/messages/messageId/notes'

Private DELETE_NOTE

DELETE_NOTE: string = '/dfo/3.0/messages/messageId/notes/noteId'

Private UPDATE_NOTE

UPDATE_NOTE: string = '/dfo/3.0/messages/messageId/notes/noteId'

Private auth

auth: CXoneAuth

logger

logger: CcfLogger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

createMessageNote

  • createMessageNote(messageId: string, content: string): Promise<CXoneSdkError | AssertsShape<{ content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>

  • Method to create note

    example
    • digitalService.createMessageNote('382a92bf-913b-4d7b-9190-7c3a17c42fe0', 'content')

    Parameters

    • messageId: string

      message id for which the note is created

    • content: string

      content of the note

    Returns Promise<CXoneSdkError | AssertsShape<{ content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>

    • object with notes creation details

deleteMessageNote

  • Method to delete notes

    example
    • digitalService.deleteMessageNote('382a92bf-913b-4d7b-9190-7c3a17c42fe0','3245')

    Parameters

    • messageId: string

      message id for which the note is created

    • noteId: string

      id of the note

    Returns Promise<HttpResponse | CXoneSdkError>

    • No response

updateMessageNote

  • updateMessageNote(messageId: string, content: string, noteId: string): Promise<CXoneSdkError | AssertsShape<{ content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>

  • Method to update notes

    example
    • digitalService.updateMessageNote('382a92bf-913b-4d7b-9190-7c3a17c42fe0', 'content', '3241')

    Parameters

    • messageId: string

      message id for which the note is created

    • content: string

      content of the note

    • noteId: string

      id of the note

    Returns Promise<CXoneSdkError | AssertsShape<{ content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>

    • object with notes updation details

Generated using TypeDoc