UpdateRequestSocket

@codebolt/client-sdk

---

Class: UpdateRequestSocket

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:11

Project Structure Update Request WebSocket - Manage update requests with workflow. Type-based protocol: list, get, create, update, delete, submit, startWork, complete, merge, dispute, resolveDispute, comment, watch, unwatch.

Extends

• TypedEventEmitter<UpdateRequestSocketEvents>

Constructors

Constructor

new UpdateRequestSocket(connectionManager: SocketConnectionManager, socketName: string): UpdateRequestSocket;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:14

Parameters

Parameter	Type	Default value
connectionManager	SocketConnectionManager	undefined
socketName	string	'projectStructureUpdateRequest'

Returns

UpdateRequestSocket

Overrides

TypedEventEmitter.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
listeners	protected	Map<string | symbol, Set<(...args: any[]) => void>>	TypedEventEmitter.listeners	CodeBolt/packages/clientsdk/src/core/event-emitter.ts:24

Methods

comment()

comment(
   id: string, 
   comment: string, 
   requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:95

Parameters

Parameter	Type
id	string
comment	string
requestId?	string

Returns

void

---

complete()

complete(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:79

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

create()

create(request: CreateUpdateRequestRequest, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:64

Parameters

Parameter	Type
request	CreateUpdateRequestRequest
requestId?	string

Returns

void

---

delete()

delete(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:70

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

dispute()

dispute(
   id: string, 
   reason: string, 
   requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:85

Parameters

Parameter	Type
id	string
reason	string
requestId?	string

Returns

void

---

emit()

emit<K>(event: K, ...args: Parameters<UpdateRequestSocketEvents[K]>): boolean;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:54

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
...args	Parameters<UpdateRequestSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

get()

get(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:61

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

list()

list(filter?: unknown, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:58

Parameters

Parameter	Type
filter?	unknown
requestId?	string

Returns

void

---

listenerCount()

listenerCount(event: string): number;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:75

Parameters

Parameter	Type
event	string

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

merge()

merge(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:82

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

off()

off<K>(event: K, listener: UpdateRequestSocketEvents[K]): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:35

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	UpdateRequestSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: UpdateRequestSocketEvents[K]): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:27

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	UpdateRequestSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: UpdateRequestSocketEvents[K]): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:46

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	UpdateRequestSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

removeAllListeners()

removeAllListeners(event?: string): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:66

Parameters

Parameter	Type
event?	string

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

resolveDispute()

resolveDispute(
   id: string, 
   resolution: unknown, 
   requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:88

Parameters

Parameter	Type
id	string
resolution	unknown
requestId?	string

Returns

void

---

startWork()

startWork(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:76

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

submit()

submit(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:73

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

unwatch()

unwatch(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:101

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void

---

update()

update(
   id: string, 
   data: UpdateUpdateRequestRequest, 
   requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:67

Parameters

Parameter	Type
id	string
data	UpdateUpdateRequestRequest
requestId?	string

Returns

void

---

watch()

watch(id: string, requestId?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/update-request.socket.ts:98

Parameters

Parameter	Type
id	string
requestId?	string

Returns

void