Class GuildController

Hierarchy (View Summary, Expand)

controller
- GuildController

Index

Constructors

constructor

Methods

getChannels getRoles index response view

Constructors

constructor

new GuildController(application: Application): GuildController
Parameters
- application: Application
Returns GuildController
Inherited from controller.constructor
- Defined in src/framework/typescript/api/http/Controller.ts:24

Properties

`Protected` `Readonly`application

application: Application

Methods

getChannels

getChannels(
    request: Request,
):
    | response<unknown>
    | {
        id: string;
        name: string;
        type:
            | GuildText
            | GuildVoice
            | GuildCategory
            | GuildAnnouncement
            | AnnouncementThread
            | PublicThread
            | PrivateThread
            | GuildStageVoice
            | GuildForum
            | GuildMedia;
    }[]
Parameters
- request: Request
Returns
    | response<unknown>
    | {
        id: string;
        name: string;
        type:
            | GuildText
            | GuildVoice
            | GuildCategory
            | GuildAnnouncement
            | AnnouncementThread
            | PublicThread
            | PrivateThread
            | GuildStageVoice
            | GuildForum
            | GuildMedia;
    }[]
- Defined in src/main/typescript/api/controllers/GuildController.ts:89

getRoles

getRoles(
request: Request,
): response<unknown> | { color: number; id: string; name: string }[]
Parameters
- request: Request
Returns response<unknown> | { color: number; id: string; name: string }[]
- Defined in src/main/typescript/api/controllers/GuildController.ts:69

index

index(request: Request): { icon: null | string; id: string; name: string }[]
Parameters
- request: Request
Returns { icon: null | string; id: string; name: string }[]
- Defined in src/main/typescript/api/controllers/GuildController.ts:51

`Protected`response

response(
    status: number,
    body?: unknown,
    headers?: Record<string, string>,
): response<unknown>
Parameters
- status: number
- Optionalbody: unknown
- Optionalheaders: Record<string, string>
Returns response<unknown>
Inherited from controller.response
- Defined in src/framework/typescript/api/http/Controller.ts:28

view

view(
request: Request,
): response<unknown> | { icon: null | string; id: string; name: string }
Parameters
- request: Request
Returns response<unknown> | { icon: null | string; id: string; name: string }
- Defined in src/main/typescript/api/controllers/GuildController.ts:31

Class GuildController

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GuildController

Properties

`Protected` `Readonly`application

Methods

getChannels

Parameters

getRoles

Parameters

Returns response<unknown> | { color: number; id: string; name: string }[]

index

Parameters

Returns { icon: null | string; id: string; name: string }[]

`Protected`response

Parameters

Returns response<unknown>

view

Parameters

Returns response<unknown> | { icon: null | string; id: string; name: string }

Settings

On This Page

Class GuildController

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GuildController

Properties

Protected Readonlyapplication

Methods

getChannels

Parameters

Returns | response<unknown> | { id: string; name: string; type: | GuildText | GuildVoice | GuildCategory | GuildAnnouncement | AnnouncementThread | PublicThread | PrivateThread | GuildStageVoice | GuildForum | GuildMedia; }[]

getRoles

Parameters

Returns response<unknown> | { color: number; id: string; name: string }[]

index

Parameters

Returns { icon: null | string; id: string; name: string }[]

Protectedresponse

Parameters

Returns response<unknown>

view

Parameters

Returns response<unknown> | { icon: null | string; id: string; name: string }

Settings

On This Page

`Protected` `Readonly`application

Returns
| response<unknown>
| {
id: string;
name: string;
type:
| GuildText
| GuildVoice
| GuildCategory
| GuildAnnouncement
| AnnouncementThread
| PublicThread
| PrivateThread
| GuildStageVoice
| GuildForum
| GuildMedia;
}[]

`Protected`response