@egain/ai-agent-sdk API Reference - v0.2.3-beta.2 / GetPortalsOptions

Interface: GetPortalsOptions

Options for ApiHelper.getMyPortals.

Hierarchy

• GetMyPortalsOptions

  ↳ GetPortalsOptions

Table of contents

Properties

• authToken
• language
• userId
• shortUrlTemplate
• departmentId

Properties

authToken

• Optional authToken: string

Authentication token (required if ApiHelper was constructed without getToken)

Inherited from

GetMyPortalsOptions.authToken

Defined in

core/api/ApiHelper.ts:202

---

language

• Optional language: string

Language code (e.g., "en-us", "da-dk")

Default

"en-us"

Inherited from

GetMyPortalsOptions.language

Defined in

core/api/ApiHelper.ts:208

---

userId

• Optional userId: string

Optional user ID for cache keying

Inherited from

GetMyPortalsOptions.userId

Defined in

core/api/ApiHelper.ts:213

---

shortUrlTemplate

• Optional shortUrlTemplate: string

Optional short URL template for filtering (from agent theme)

Inherited from

GetMyPortalsOptions.shortUrlTemplate

Defined in

core/api/ApiHelper.ts:218

---

departmentId

• Optional departmentId: string | number

Department ID (from portal.department.id)

Defined in

core/api/ApiHelper.ts:225