Class CommentManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new CommentManager(__namedParameters): CommentManager
Parameters
- __namedParameters: BetterUptime
Returns CommentManager
- Defined in comments/CommentManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(incident_id, newComment): Promise<any>
Returns either a newly created comment, or validation errors.
Parameters
- incident_id: string
- newComment: string
Returns Promise<any>
- Defined in comments/CommentManager.ts:45

delete

delete(incident_id, comment_id): Promise<boolean>
Permanently deletes an existing comment.
Parameters
- incident_id: string
- comment_id: string
  Comment ID you want to remove
Returns Promise<boolean>
True if success
- Defined in comments/CommentManager.ts:94

get

get(incident_id, comment_id): Promise<any>
This will return an existing comment.
Parameters
- incident_id: string
- comment_id: string
Returns Promise<any>
- Defined in comments/CommentManager.ts:25

getAll

getAll(incident_id): Promise<any>
List all comments under an incident.
Parameters
- incident_id: string
Returns Promise<any>
- Defined in comments/CommentManager.ts:15

update

update(incident_id, comment_id, updatedComment): Promise<any>
This will update an existing comment. You can only update a comment created by the API.
Parameters
- incident_id: string
- comment_id: string
  Comment ID you want to change
- updatedComment: string
Returns Promise<any>
- Defined in comments/CommentManager.ts:67

Generated using TypeDoc