Package discord4j.rest.entity
Class RestGuildTemplate
- java.lang.Object
-
- discord4j.rest.entity.RestGuildTemplate
-
public class RestGuildTemplate extends Object
Represents a guild template entity in Discord.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RestGuildTemplate
create(RestClient restClient, String code)
Create aRestGuildTemplate
with the given code.Mono<discord4j.discordjson.json.GuildData>
createGuild(discord4j.discordjson.json.TemplateCreateGuildRequest request)
Create a new guild based on this template.boolean
equals(Object o)
String
getCode()
Gets the code of this template.Mono<discord4j.discordjson.json.TemplateData>
getData()
Retrieve this template's data upon subscription.int
hashCode()
-
-
-
Method Detail
-
create
public static RestGuildTemplate create(RestClient restClient, String code)
Create aRestGuildTemplate
with the given code. This method does not perform any API request.- Parameters:
restClient
- REST API resourcescode
- the template's code- Returns:
- a
RestTemplate
represented by the given code.
-
getCode
public String getCode()
Gets the code of this template.- Returns:
- The code of this template
-
getData
public Mono<discord4j.discordjson.json.TemplateData> getData()
Retrieve this template's data upon subscription.- Returns:
- a template object
-
createGuild
public Mono<discord4j.discordjson.json.GuildData> createGuild(discord4j.discordjson.json.TemplateCreateGuildRequest request)
Create a new guild based on this template.This endpoint can be used only by bots in less than 10 guilds.
- Returns:
- a guild object
-
-