@valoranchi/riot-client / raw / ChatApi

Class: ChatApi

Defined in: src/local/ChatApi.ts:20

Constructors

Constructor

new ChatApi(localApi): ChatApi

Defined in: src/local/ChatApi.ts:23

Parameters

localApi

RiotClientLocalApi

Returns

ChatApi

Methods

blocked()

blocked(): Promise<RawBlockedPlayer[]>

Defined in: src/local/ChatApi.ts:42

Returns

Promise<RawBlockedPlayer[]>

---

blockPlayer()

blockPlayer(puuid): Promise<void>

Defined in: src/local/ChatApi.ts:114

Parameters

puuid

string

Returns

Promise<void>

---

conversations()

conversations(): Promise<RawConversation[]>

Defined in: src/local/ChatApi.ts:47

Returns

Promise<RawConversation[]>

---

deleteFriendRequest()

deleteFriendRequest(puuid): Promise<void>

Defined in: src/local/ChatApi.ts:106

Parameters

puuid

string

Returns

Promise<void>

---

friendRequests()

friendRequests(): Promise<RawFriendRequest[]>

Defined in: src/local/ChatApi.ts:37

Returns

Promise<RawFriendRequest[]>

---

friends()

friends(): Promise<RawChatFriend[]>

Defined in: src/local/ChatApi.ts:27

Returns

Promise<RawChatFriend[]>

---

messages()

messages(cid?): Promise<RawChatMessage[]>

Defined in: src/local/ChatApi.ts:76

Parameters

cid?

string

Returns

Promise<RawChatMessage[]>

---

participants()

participants(cid?): Promise<RawParticipant[]>

Defined in: src/local/ChatApi.ts:122

Parameters

cid?

string

Returns

Promise<RawParticipant[]>

---

presences()

presences(): Promise<RawChatPresence[]>

Defined in: src/local/ChatApi.ts:32

Returns

Promise<RawChatPresence[]>

---

removeFriend()

removeFriend(puuid): Promise<void>

Defined in: src/local/ChatApi.ts:110

Parameters

puuid

string

Returns

Promise<void>

---

sendFriendRequest()

sendFriendRequest(gameName, gameTag): Promise<void>

Defined in: src/local/ChatApi.ts:99

Parameters

gameName

string

gameTag

string

Returns

Promise<void>

---

sendMessage()

sendMessage(cid, message, type): Promise<RawChatMessage>

Defined in: src/local/ChatApi.ts:91

Parameters

cid

string

message

string

type

"chat" | "groupchat"

Returns

Promise<RawChatMessage>

---

session()

session(): Promise<RawChatSession | null>

Defined in: src/local/ChatApi.ts:82

Returns

Promise<RawChatSession | null>

---

unblockPlayer()

unblockPlayer(puuid): Promise<void>

Defined in: src/local/ChatApi.ts:118

Parameters

puuid

string

Returns

Promise<void>