ThreadService | Kelvin SDK Client Library Reference

Hierarchy

BaseService
- ThreadService

Index

Methods

Static createThread

createThread(__namedParameters: { body: string; file: Blob }, options?: IKvHttpRequestOptions): Observable<Thread>

Create Thread Create Thread Permission Required: `kelvin.permission.thread.create`

Parameters
- __namedParameters: { body: string; file: Blob }
  - body: string
    
    requests.ThreadCreate schema
  - file: Blob
    
    Attachment
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static createThreadReply

createThreadReply(__namedParameters: { body: string; file: Blob; replyId: string; threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Create Thread Reply Create Thread Reply Permission Required: `kelvin.permission.thread.create`

Parameters
- __namedParameters: { body: string; file: Blob; replyId: string; threadId: string }
  - body: string
    
    requests.ThreadReplyCreate schema
  - file: Blob
    
    Attachment
  - replyId: string
    
    Reply ID
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static deleteThread

deleteThread(__namedParameters: { threadId: string }, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>

Delete Thread Delete Thread Permission Required: `kelvin.permission.thread.delete`

Parameters
- __namedParameters: { threadId: string }
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IKvHttpResponse>

Static deleteThreadReply

deleteThreadReply(__namedParameters: { replyId: string; threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Delete Thread Reply Delete Thread Reply Permission Required: `kelvin.permission.thread.delete`

Parameters
- __namedParameters: { replyId: string; threadId: string }
  - replyId: string
    
    Reply ID
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static getPaginator

getPaginator<T>(request: Observable<IPaginatedRequest<T>>): KvPaginator<T>

Inherited from BaseService.getPaginator

Type parameters
- T: Model
Parameters
- request: Observable<IPaginatedRequest<T>>
Returns KvPaginator<T>

Static getThread

getThread(__namedParameters: { threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Get Thread Get Thread Permission Required: `kelvin.permission.thread.read`

Parameters
- __namedParameters: { threadId: string }
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static listThreads

listThreads(__namedParameters?: { relatedTo: string; type: string; userId: string }, options?: IKvHttpRequestOptions): Observable<Thread[]>

List Threads List Threads Pagination Sortable Columns: `thread.id` Permission Required: `kelvin.permission.thread.read`

Parameters
- Default value __namedParameters: { relatedTo: string; type: string; userId: string } = {}
  - relatedTo: string
    
    Filter threads by related_to
  - type: string
    
    Filter threads by type
  - userId: string
    
    Filter threads by user_id
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread[]>

Static onError

onError(): Observable<IKvHttpResponse>

Inherited from BaseService.onError

Returns Observable<IKvHttpResponse>

Static request

request<T>(endpoint: string, request: IKvHttpRequest, modelClass?: IModel): Observable<T>

Inherited from BaseService.request

Type parameters
- T
Parameters
- endpoint: string
- request: IKvHttpRequest
- Optional modelClass: IModel
Returns Observable<T>

Static requestUrl

requestUrl<T>(request: IKvHttpRequest, modelClass?: IModel, autenticated?: boolean): Observable<T>

Inherited from BaseService.requestUrl

Type parameters
- T
Parameters
- request: IKvHttpRequest
- Optional modelClass: IModel
- Default value autenticated: boolean = false
Returns Observable<T>

Static updateThread

updateThread(__namedParameters: { body: string; file: Blob; threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Update Thread Update Thread Permission Required: `kelvin.permission.thread.update`

Parameters
- __namedParameters: { body: string; file: Blob; threadId: string }
  - body: string
    
    requests.ThreadUpdate schema
  - file: Blob
    
    Attachment
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static updateThreadFollow

updateThreadFollow(__namedParameters: { follow: boolean; threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Update Thread Follow Update Thread Follow Permission Required: `kelvin.permission.thread.read`

Parameters
- __namedParameters: { follow: boolean; threadId: string }
  - follow: boolean
    
    Set user follow value to true or false
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static updateThreadReply

updateThreadReply(__namedParameters: { body: string; file: Blob; replyId: string; threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Update Thread Reply Update Thread Reply Permission Required: `kelvin.permission.thread.update`

Parameters
- __namedParameters: { body: string; file: Blob; replyId: string; threadId: string }
  - body: string
    
    requests.ThreadReplyUpdate schema
  - file: Blob
    
    Attachment
  - replyId: string
    
    Reply ID
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Static updateThreadSeen

updateThreadSeen(__namedParameters: { seen: boolean; threadId: string }, options?: IKvHttpRequestOptions): Observable<Thread>

Update Thread Seen Update Thread Seen Permission Required: `kelvin.permission.thread.read`

Parameters
- __namedParameters: { seen: boolean; threadId: string }
  - seen: boolean
    
    Set user seen value to true or false
  - threadId: string
    
    Thread ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Thread>

Hierarchy

Index

Methods

Methods

Static createThread

Parameters

__namedParameters: { body: string; file: Blob }

body: string

file: Blob

Optional options: IKvHttpRequestOptions

Returns Observable<Thread>

Static createThreadReply

Parameters

__namedParameters: { body: string; file: Blob; replyId: string; threadId: string }

body: string

file: Blob

replyId: string

threadId: string

Optional options: IKvHttpRequestOptions

Returns Observable<Thread>

Static deleteThread

Parameters

__namedParameters: { threadId: string }

threadId: string

Optional options: IKvHttpRequestOptions

Returns Observable<IKvHttpResponse>

Static deleteThreadReply

Parameters

__namedParameters: { replyId: string; threadId: string }

replyId: string

threadId: string

Optional options: IKvHttpRequestOptions

Returns Observable<Thread>

Static getPaginator

Type parameters

T: Model

Parameters

request: Observable<IPaginatedRequest<T>>

Returns KvPaginator<T>

Static getThread

Parameters

__namedParameters: { threadId: string }

threadId: string

Optional options: IKvHttpRequestOptions

Returns Observable<Thread>

Static listThreads

Parameters

Default value __namedParameters: { relatedTo: string; type: string; userId: string } = {}

relatedTo: string

type: string

userId: string

Optional options: IKvHttpRequestOptions

Returns Observable<Thread[]>

Static onError

Returns Observable<IKvHttpResponse>

Static request

Type parameters

T

Parameters

endpoint: string

request: IKvHttpRequest

Optional modelClass: IModel

Returns Observable<T>

Static requestUrl

Type parameters

T

Parameters

request: IKvHttpRequest

Optional modelClass: IModel

Default value autenticated: boolean = false

Returns Observable<T>

Static updateThread

Parameters

__namedParameters: { body: string; file: Blob; threadId: string }

body: string

file: Blob

threadId: string

Optional options: IKvHttpRequestOptions

Returns Observable<Thread>

Static updateThreadFollow