Supported Endpoints

Supported endpoints

Every method below lives on RestClient (jg_api.getRestClient()) and returns a RestAction<T>; see RestActions for how to run them. Many entities expose shortcuts for the same calls (for example ChatMessage#delete() or ForumTopic#lock()).

Servers

Method	Returns
`getServer(String serverId)`	`ServerModel`

Channels

Method	Returns
`createChannel(ServerChannel channel)`	`ServerChannel`
`createChannel(String name, String topic, boolean isPublic, String type, String serverId, String groupId, String categoryId)`	`ServerChannel`
`getChannel(String channelId)`	`ServerChannel`
`updateChannel(String channelId, ServerChannel channel)`	`ServerChannel`
`updateChannel(String channelId, String name, String topic, boolean isPublic)`	`ServerChannel`
`deleteChannel(String channelId)`	`Boolean`
`archiveChannel(String channelId)`	`ServerChannel`
`unarchiveChannel(String channelId)`	`Boolean`

Messages

Method	Returns
`createChannelMessage(String channelId, ChatMessage message)`	`ChatMessage`
`createChannelMessage(String channelId, boolean isPrivate, boolean isSilent, String[] replyMessageIds, String content, ChatEmbed[] embeds)`	`ChatMessage`
`getMessages(String channelId, Instant before, Instant after, int limit, boolean includePrivate)`	`ChatMessage[]`
`getMessage(String channelId, String messageId)`	`ChatMessage`
`updateMessage(String channelId, String messageId, ChatMessage message)`	`ChatMessage`
`updateMessage(String channelId, String messageId, String content, ChatEmbed[] embeds)`	`ChatMessage`
`deleteMessage(String channelId, String messageId)`	`Boolean`
`pinMessage(String channelId, String messageId)`	`Boolean`
`unpinMessage(String channelId, String messageId)`	`Boolean`

Members

Method	Returns
`updateNickname(String serverId, String userId, ServerMember serverMember)`	`String`
`updateNickname(String serverId, String userId, String nickname)`	`String`
`deleteNickname(String serverId, String userId)`	`Boolean`
`getMember(String serverId, String userId)`	`ServerMember`
`kickMember(String serverId, String userId)`	`Boolean`
`getMembers(String serverId)`	`ServerMemberSummary[]`

Member bans

Method	Returns
`createServerBan(String serverId, String userId, ServerMemberBan serverMemberBan)`	`ServerMemberBan`
`createServerBan(String serverId, String userId, String reason)`	`ServerMemberBan`
`getServerBan(String serverId, String userId)`	`ServerMemberBan`
`deleteServerBan(String serverId, String userId)`	`Boolean`
`getServerBans(String serverId)`	`ServerMemberBan[]`

List items

Method	Returns
`createListItem(String channelId, ListItem listItem)`	`ListItem`
`createListItem(String channelId, String message, ListItemNote note)`	`ListItem`
`getListItems(String channelId)`	`ListItem[]`
`getListItem(String channelId, String listItemId)`	`ListItem`
`updateListItem(String channelId, String listItemId, ListItem listItem)`	`ListItem`
`updateListItem(String channelId, String listItemId, String message, ListItemNote note)`	`ListItem`
`deleteListitem(String channelId, String listItemId)`	`Boolean`
`completeListItem(String channelId, String listItemId)`	`Boolean`
`uncompleteListItem(String channelId, String listItemId)`	`Boolean`

Docs

Method	Returns
`createDoc(String channelId, Doc doc)`	`Doc`
`createDoc(String channelId, String title, String content)`	`Doc`
`getDocs(String channelId, Instant before, int limit)`	`Doc[]`
`getDoc(String channelId, int docId)`	`Doc`
`updateDoc(String channelId, int docId, Doc doc)`	`Doc`
`updateDoc(String channelId, int docId, String title, String content)`	`Doc`
`deleteDoc(String channelId, int docId)`	`Boolean`
`createDocComment(String channelId, int docId, String content)`	`DocComment`
`getDocComments(String channelId, int docId)`	`DocComment[]`
`getDocComment(String channelId, int docId, int commentId)`	`DocComment`
`updateDocComment(String channelId, int docId, int commentId, String content)`	`DocComment`
`deleteDocComment(String channelId, int docId, int commentId)`	`Boolean`

Reactions

Method	Returns
`addReactionEmote(String channelId, String contentId, String emoteId)`	`Boolean`
`removeReactionEmote(String channelId, String contentId, String emoteId)`	`Boolean`

Server XP

Method	Returns
`awardMemberXP(String serverId, String userId, int amount)`	`Integer`
`setMemberXP(String serverId, String userId, int total)`	`Integer`
`awardRoleXP(String serverId, String roleId, int amount)`	`Boolean`

Social links

Method	Returns
`getSocialLinks(String serverId, String userId, String type)`	`SocialLink`
`getSocialLink(String serverId, String userId, String type)`	`SocialLink`

Group & role memberships

Method	Returns
`addMemberToGroup(String groupId, String userId)`	`Boolean`
`removeMemberFromGroup(String groupId, String userId)`	`Boolean`
`addRoleToMember(String serverId, String userId, int roleId)`	`Boolean`
`removeRoleFromMember(String serverId, String userId, int roleId)`	`Boolean`
`getMemberRoles(String serverId, String userId)`	`Integer[]`

Webhooks

Method	Returns
`createWebhook(String serverId, Webhook webhook)`	`Webhook`
`createWebhook(String serverId, String name, String channelId)`	`Webhook`
`getWebhooks(String serverId, String channelId)`	`Webhook[]`
`getWebhook(String serverId, String webhookId)`	`Webhook`
`updateWebhook(String serverId, String webhookId, Webhook webhook)`	`Webhook`
`updateWebhook(String serverId, String webhookId, String name, String channelId)`	`Webhook`
`deleteWebhook(String serverId, String webhookId)`	`Boolean`
`executeWebhook(String webhookId, String webhookToken, String content, String username, String avatarUrl, ChatEmbed[] embeds)`	`Boolean`

Calendar events

Method	Returns
`createCalendarEvent(String channelId, CalendarEvent calendarEvent)`	`CalendarEvent`
`getCalendarEvents(String channelId, Instant before, Instant after, int limit)`	`CalendarEvent[]`
`getCalendarEvent(String channelId, String calendarEventId)`	`CalendarEvent`
`updateCalendarEvent(String channelId, int calendarEventId, CalendarEvent calendarEvent)`	`CalendarEvent`
`updateCalendarEvent(String channelId, int calendarEventId, String name, String description, String location, Instant startsAt, String url, int color, int duration, boolean isPrivate)`	`CalendarEvent`
`deleteCalendarEvent(String channelId, int calendarEventId)`	`Boolean`
`getCalendarEventRsvp(String channelId, int calendarEventId, String userId)`	`CalendarEventRsvp`
`getCalendarEventRsvps(String channelId, String calendarEventId)`	`CalendarEventRsvp[]`
`updateCalendarEventRsvp(String channelId, String calendarEventId, String userId, String status)`	`CalendarEventRsvp`
`updateCalendarEventRsvps(String channelId, int calendarEventId, String[] userIds, String status)`	`Boolean`
`deleteCalendarEventRsvp(String channelId, String calendarEventId, String userId)`	`Boolean`
`createCalendarEventComment(String channelId, int calendarEventId, String content)`	`CalendarEventComment`
`getCalendarEventComments(String channelId, int calendarEventId)`	`CalendarEventComment[]`
`getCalendarEventComment(String channelId, int calendarEventId, int commentId)`	`CalendarEventComment`
`updateCalendarEventComment(String channelId, int calendarEventId, int commentId, String content)`	`CalendarEventComment`
`deleteCalendarEventComment(String channelId, int calendarEventId, int commentId)`	`Boolean`

Forum topics

Method	Returns
`createForumTopic(String channelId, ForumTopic forumTopic)`	`ForumTopic`
`createForumTopic(String channelId, String title, String content)`	`ForumTopic`
`getForumTopics(String channelId)`	`ForumTopic[]`
`getForumTopics(String channelId, Instant before, int limit)`	`ForumTopic[]`
`getForumTopic(String channelId, String forumTopicId)`	`ForumTopic`
`updateForumTopic(String channelId, String forumTopicId, ForumTopic forumTopic)`	`ForumTopic`
`updateForumTopic(String channelId, String forumTopicId, String title, String content)`	`ForumTopic`
`deleteForumTopic(String channelId, String forumTopicId)`	`Boolean`
`pinForumTopic(String channelId, int forumTopicId)`	`Boolean`
`unpinForumTopic(String channelId, int forumTopicId)`	`Boolean`
`lockForumTopic(String channelId, int forumTopicId)`	`Boolean`
`unlockForumTopic(String channelId, int forumTopicId)`	`Boolean`
`createForumTopicComment(String channelId, int forumTopicId, String content)`	`ForumTopicComment`
`getForumTopicComments(String channelId, int forumTopicId)`	`ForumTopicComment[]`
`getForumTopicComment(String channelId, int forumTopicId, int commentId)`	`ForumTopicComment`
`updateForumTopicComment(String channelId, int forumTopicId, int commentId, String content)`	`ForumTopicComment`
`deleteForumTopicComment(String channelId, int forumTopicId, int commentId)`	`Boolean`

Announcements

Method	Returns
`createAnnouncement(String channelId, String title, String content)`	`Announcement`
`getAnnouncements(String channelId)`	`Announcement[]`
`getAnnouncements(String channelId, Instant before, int limit)`	`Announcement[]`
`getAnnouncement(String channelId, String announcementId)`	`Announcement`
`updateAnnouncement(String channelId, String announcementId, String title, String content)`	`Announcement`
`deleteAnnouncement(String channelId, String announcementId)`	`Boolean`
`createAnnouncementComment(String channelId, String announcementId, String content)`	`AnnouncementComment`
`getAnnouncementComments(String channelId, String announcementId)`	`AnnouncementComment[]`
`getAnnouncementComment(String channelId, String announcementId, int commentId)`	`AnnouncementComment`
`updateAnnouncementComment(String channelId, String announcementId, int commentId, String content)`	`AnnouncementComment`
`deleteAnnouncementComment(String channelId, String announcementId, int commentId)`	`Boolean`

Methods that return RestAction<Boolean> don't have a payload, the value is true when the request succeeded.

JG_API

Home

Getting started

Guides

More

FAQ
Javadoc

Navigation Menu

Repository navigation

Supported Endpoints

Supported endpoints

Servers

Channels

Messages

Members

Member bans

List items

Docs

Reactions

Server XP

Social links

Group & role memberships

Webhooks

Calendar events

Forum topics

Announcements

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally