Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): update gateway documentation links #628

Merged
merged 1 commit into from
Oct 30, 2022
Merged

fix(docs): update gateway documentation links #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion deno/gateway/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* https://discord.com/developers/docs/topics/gateway#connecting-gateway-url-params
* https://discord.com/developers/docs/topics/gateway#connecting-gateway-url-query-string-params
*/
export interface GatewayURLQuery {
v: string;
Expand Down
356 changes: 178 additions & 178 deletions deno/gateway/v10.ts
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions deno/gateway/v8.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1686,7 +1686,7 @@ export interface GatewayPresenceUpdateData {
/**
* The user's activities
*
* See https://discord.com/developers/docs/topics/gateway#activity-object
* See https://discord.com/developers/docs/topics/gateway-events#activity-object
*/
activities: GatewayActivityUpdateData[];
/**
Expand All @@ -1702,7 +1702,7 @@ export interface GatewayPresenceUpdateData {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-structure
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
export type GatewayActivityUpdateData = Pick<GatewayActivity, 'name' | 'type' | 'url'>;
Expand Down
356 changes: 178 additions & 178 deletions deno/gateway/v9.ts
View file
Open in desktop

Large diffs are not rendered by default.

44 changes: 23 additions & 21 deletions deno/payloads/v10/gateway.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/**
* Types extracted from https://discord.com/developers/docs/topics/gateway
* Types extracted from
* - https://discord.com/developers/docs/topics/gateway
* - https://discord.com/developers/docs/topics/gateway-events
*/

import type { APIChannel, APIThreadMember } from './channel.ts';
Expand Down Expand Up @@ -58,7 +60,7 @@ export interface APIGatewaySessionStartLimit {
}

/**
* https://discord.com/developers/docs/topics/gateway#presence-update-presence-update-event-fields
* https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields
*/
export interface GatewayPresenceUpdate {
/**
Expand All @@ -81,13 +83,13 @@ export interface GatewayPresenceUpdate {
/**
* User's current activities
*
* See https://discord.com/developers/docs/topics/gateway#activity-object
* See https://discord.com/developers/docs/topics/gateway-events#activity-object
*/
activities?: GatewayActivity[];
/**
* User's platform-dependent status
*
* See https://discord.com/developers/docs/topics/gateway#client-status-object
* See https://discord.com/developers/docs/topics/gateway-events#client-status-object
*/
client_status?: GatewayPresenceClientStatus;
}
Expand All @@ -104,7 +106,7 @@ export enum PresenceUpdateStatus {
}

/**
* https://discord.com/developers/docs/topics/gateway#client-status-object
* https://discord.com/developers/docs/topics/gateway-events#client-status-object
*/
export interface GatewayPresenceClientStatus {
/**
Expand All @@ -122,7 +124,7 @@ export interface GatewayPresenceClientStatus {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-structure
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure
*/
export interface GatewayActivity {
/**
Expand All @@ -137,7 +139,7 @@ export interface GatewayActivity {
/**
* Activity type
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-types
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
*/
type: ActivityType;
/**
Expand Down Expand Up @@ -177,7 +179,7 @@ export interface GatewayActivity {
/**
* The emoji used for a custom status
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-emoji
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
*/
emoji?: GatewayActivityEmoji;
/**
Expand All @@ -187,19 +189,19 @@ export interface GatewayActivity {
/**
* Information for the current party of the player
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-party
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
*/
party?: GatewayActivityParty;
/**
* Images for the presence and their hover texts
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-assets
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
*/
assets?: GatewayActivityAssets;
/**
* Secrets for Rich Presence joining and spectating
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-secrets
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
*/
secrets?: GatewayActivitySecrets;
/**
Expand All @@ -209,7 +211,7 @@ export interface GatewayActivity {
/**
* Activity flags `OR`d together, describes what the payload includes
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
*
* See https://en.wikipedia.org/wiki/Bit_field
*/
Expand All @@ -236,7 +238,7 @@ export enum ActivityPlatform {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-types
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
*/
export enum ActivityType {
/**
Expand Down Expand Up @@ -266,7 +268,7 @@ export enum ActivityType {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-timestamps
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps
*/
export interface GatewayActivityTimestamps {
/**
Expand All @@ -280,12 +282,12 @@ export interface GatewayActivityTimestamps {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-emoji
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
*/
export type GatewayActivityEmoji = Partial<Pick<APIEmoji, 'id' | 'animated'>> & Pick<APIEmoji, 'name'>;

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-party
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
*/
export interface GatewayActivityParty {
/**
Expand All @@ -299,19 +301,19 @@ export interface GatewayActivityParty {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-assets
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
*/
export type GatewayActivityAssets = Partial<
Record<'large_image' | 'large_text' | 'small_image' | 'small_text', string>
>;

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-secrets
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
*/
export type GatewayActivitySecrets = Partial<Record<'join' | 'spectate' | 'match', string>>;

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
*/
export enum ActivityFlags {
Instance = 1 << 0,
Expand All @@ -337,7 +339,7 @@ export interface GatewayActivityButton {
}

/**
* https://discord.com/developers/docs/topics/gateway#thread-list-sync-thread-list-sync-event-fields
* https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields
*/
export interface GatewayThreadListSync {
/**
Expand All @@ -359,7 +361,7 @@ export interface GatewayThreadListSync {
}

/**
* https://discord.com/developers/docs/topics/gateway#thread-members-update-thread-members-update-event-fields
* https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields
*/
export interface GatewayThreadMembersUpdate {
/**
Expand Down
44 changes: 23 additions & 21 deletions deno/payloads/v9/gateway.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/**
* Types extracted from https://discord.com/developers/docs/topics/gateway
* Types extracted from
* - https://discord.com/developers/docs/topics/gateway
* - https://discord.com/developers/docs/topics/gateway-events
*/

import type { APIChannel, APIThreadMember } from './channel.ts';
Expand Down Expand Up @@ -58,7 +60,7 @@ export interface APIGatewaySessionStartLimit {
}

/**
* https://discord.com/developers/docs/topics/gateway#presence-update-presence-update-event-fields
* https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields
*/
export interface GatewayPresenceUpdate {
/**
Expand All @@ -81,13 +83,13 @@ export interface GatewayPresenceUpdate {
/**
* User's current activities
*
* See https://discord.com/developers/docs/topics/gateway#activity-object
* See https://discord.com/developers/docs/topics/gateway-events#activity-object
*/
activities?: GatewayActivity[];
/**
* User's platform-dependent status
*
* See https://discord.com/developers/docs/topics/gateway#client-status-object
* See https://discord.com/developers/docs/topics/gateway-events#client-status-object
*/
client_status?: GatewayPresenceClientStatus;
}
Expand All @@ -104,7 +106,7 @@ export enum PresenceUpdateStatus {
}

/**
* https://discord.com/developers/docs/topics/gateway#client-status-object
* https://discord.com/developers/docs/topics/gateway-events#client-status-object
*/
export interface GatewayPresenceClientStatus {
/**
Expand All @@ -122,7 +124,7 @@ export interface GatewayPresenceClientStatus {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-structure
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure
*/
export interface GatewayActivity {
/**
Expand All @@ -136,7 +138,7 @@ export interface GatewayActivity {
/**
* Activity type
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-types
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
*/
type: ActivityType;
/**
Expand Down Expand Up @@ -171,26 +173,26 @@ export interface GatewayActivity {
/**
* The emoji used for a custom status
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-emoji
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
*/
emoji?: GatewayActivityEmoji;
session_id?: string;
/**
* Information for the current party of the player
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-party
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
*/
party?: GatewayActivityParty;
/**
* Images for the presence and their hover texts
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-assets
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
*/
assets?: GatewayActivityAssets;
/**
* Secrets for Rich Presence joining and spectating
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-secrets
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
*/
secrets?: GatewayActivitySecrets;
/**
Expand All @@ -200,7 +202,7 @@ export interface GatewayActivity {
/**
* Activity flags `OR`d together, describes what the payload includes
*
* See https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
*
* See https://en.wikipedia.org/wiki/Bit_field
*/
Expand All @@ -227,7 +229,7 @@ export enum ActivityPlatform {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-types
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
*/
export enum ActivityType {
/**
Expand Down Expand Up @@ -257,7 +259,7 @@ export enum ActivityType {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-timestamps
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps
*/
export interface GatewayActivityTimestamps {
/**
Expand All @@ -271,12 +273,12 @@ export interface GatewayActivityTimestamps {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-emoji
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
*/
export type GatewayActivityEmoji = Partial<Pick<APIEmoji, 'id' | 'animated'>> & Pick<APIEmoji, 'name'>;

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-party
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
*/
export interface GatewayActivityParty {
/**
Expand All @@ -290,19 +292,19 @@ export interface GatewayActivityParty {
}

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-assets
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
*/
export type GatewayActivityAssets = Partial<
Record<'large_image' | 'large_text' | 'small_image' | 'small_text', string>
>;

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-secrets
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
*/
export type GatewayActivitySecrets = Partial<Record<'join' | 'spectate' | 'match', string>>;

/**
* https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
*/
export enum ActivityFlags {
Instance = 1 << 0,
Expand All @@ -328,7 +330,7 @@ export interface GatewayActivityButton {
}

/**
* https://discord.com/developers/docs/topics/gateway#thread-list-sync-thread-list-sync-event-fields
* https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields
*/
export interface GatewayThreadListSync {
/**
Expand All @@ -350,7 +352,7 @@ export interface GatewayThreadListSync {
}

/**
* https://discord.com/developers/docs/topics/gateway#thread-members-update-thread-members-update-event-fields
* https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields
*/
export interface GatewayThreadMembersUpdate {
/**
Expand Down
2 changes: 1 addition & 1 deletion gateway/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* https://discord.com/developers/docs/topics/gateway#connecting-gateway-url-params
* https://discord.com/developers/docs/topics/gateway#connecting-gateway-url-query-string-params
*/
export interface GatewayURLQuery {
v: string;
Expand Down