Package discord4j.core.object.entity.channel

Interface GuildChannel

    • Method Detail

      • getGuildId

        Snowflake getGuildId()
        Gets the ID of the guild this channel is associated to.
        Returns:
        The ID of the guild this channel is associated to.

      • getGuild

        Mono<Guild> getGuild()
        Requests to retrieve the guild this channel is associated to.
        Returns:
        A Mono where, upon successful completion, emits the guild this channel is associated to. If an error is received, it is emitted through the Mono.

      • getGuild

        Mono<Guild> getGuild​(EntityRetrievalStrategy retrievalStrategy)
        Requests to retrieve the guild this channel is associated to, using the given retrieval strategy.
        Parameters:
        retrievalStrategy - the strategy to use to get the guild
        Returns:
        A Mono where, upon successful completion, emits the guild this channel is associated to. If an error is received, it is emitted through the Mono.

      • getPermissionOverwrites

        Set<ExtendedPermissionOverwrite> getPermissionOverwrites()
        Gets the permission overwrites for this channel.
        Returns:
        The permission overwrites for this channel.

      • getOverwriteForMember

        Optional<ExtendedPermissionOverwrite> getOverwriteForMember​(Snowflake memberId)
        Gets the permission overwrite targeting the given member.
        Parameters:
        memberId - The ID of the member to get the overwrite for.
        Returns:
        The permission overwrite targeting the given member.

      • getOverwriteForRole

        Optional<ExtendedPermissionOverwrite> getOverwriteForRole​(Snowflake roleId)
        Gets the permission overwrite targeting the given role.
        Parameters:
        roleId - The ID of the role to get the overwrite for.
        Returns:
        The permission overwrite targeting the given role.

      • getEffectivePermissions

        Mono<PermissionSet> getEffectivePermissions​(Snowflake memberId)
        Gets the permissions for the given member, taking into account permission overwrites in this channel.
        Parameters:
        memberId - The ID of the member to get permissions for.
        Returns:
        The permissions for the given member.

      • getName

        String getName()
        Gets the name of the channel.
        Returns:
        The name of the channel.

      • getRawPosition

        int getRawPosition()
        Gets the raw position of the channel as exposed by Discord. This may or may not be accurate with relativity to other channels in the guild.
        Returns:
        The raw position of the channel.

      • getPosition

        Mono<Integer> getPosition()
        Requests to retrieve the position of the channel relative to other channels in the guild.

        This is determined by the index of this channel in the sorted list of channels of the guild.

        Warning: Because this method must sort the guild channels, it is inefficient to make repeated invocations for the same set of channels (meaning that channels haven't been added or removed). For example, instead of writing: 

         
 guild.getChannels()
   .flatMap(c -> c.getPosition().map(pos -> c.getName() + " : " + pos))
        It would be much more efficient to write: 
         
 guild.getChannels()
   .transform(OrderUtil::orderGuildChannels)
   .index((pos, c) -> c.getName() + " : " + pos)
        Returns:
        A Mono where, upon successful completion, emits the position of the channel. If an error is received, it is emitted through the Mono.

      • addMemberOverwrite

        default Mono<Void> addMemberOverwrite​(Snowflake memberId,
                                      PermissionOverwrite overwrite)
        Requests to add a permission overwrite for the given member.
        Parameters:
        memberId - The ID of the member to add the overwrite for.
        overwrite - The overwrite to add.
        Returns:
        A Mono where, upon successful completion, emits nothing; If an error is received, it is emitted through the Mono.

      • addMemberOverwrite

        Mono<Void> addMemberOverwrite​(Snowflake memberId,
                              PermissionOverwrite overwrite,
                              @Nullable
                              String reason)
        Requests to add a permission overwrite for the given member while optionally specifying a reason.
        Parameters:
        memberId - The ID of the member to add the overwrite for.
        overwrite - The overwrite to add.
        reason - The reason, if present.
        Returns:
        A Mono where, upon successful completion, emits nothing; If an error is received, it is emitted through the Mono.

      • addRoleOverwrite

        default Mono<Void> addRoleOverwrite​(Snowflake roleId,
                                    PermissionOverwrite overwrite)
        Requests to add a permission overwrite for the given role.
        Parameters:
        roleId - The ID of the role to add the overwrite for.
        overwrite - The overwrite to add.
        Returns:
        A Mono where, upon successful completion, emits nothing; If an error is received, it is emitted through the Mono.

      • addRoleOverwrite

        Mono<Void> addRoleOverwrite​(Snowflake roleId,
                            PermissionOverwrite overwrite,
                            @Nullable
                            String reason)
        Requests to add a permission overwrite for the given role while optionally specifying a reason.
        Parameters:
        roleId - The ID of the role to add the overwrite for.
        overwrite - The overwrite to add.
        reason - The reason, if present.
        Returns:
        A Mono where, upon successful completion, emits nothing; If an error is received, it is emitted through the Mono.