DiscordPHP Documentation

GuildPreview extends Part

in package

• Application

uses GuildTrait

A guild can be previewed before joining via Membership Screening or the directory.

Tags

link

https://discord.com/developers/docs/resources/guild#guild-preview-object-guild-preview-structure

@property

?string|null $icon_hash The icon hash for the guild.

@property

?string|null $splash_hash The splash hash for the guild.

Table of Contents

Properties

$approximate_member_count  : int|null

$approximate_presence_count  : int|null

$created  : bool

Is the part already created in the Discord servers?

$description  : string|null

$discovery_splash  : string|null

$emojis  : EmojiRepository

$feature_animated_banner  : bool

$feature_animated_icon  : bool

$feature_application_command_permissions_v2  : bool

$feature_auto_moderation  : bool

$feature_banner  : bool

$feature_community  : bool

$feature_creator_monetizable_provisional  : bool

$feature_creator_store_page  : bool

$feature_developer_support_server  : bool

$feature_discoverable  : bool

$feature_enhanced_role_colors  : bool

$feature_featurable  : bool

$feature_guests_enabled  : bool

$feature_has_directory_entry  : bool

$feature_invite_splash  : bool

$feature_invites_disabled  : bool

$feature_linked_to_hub  : bool

$feature_member_verification_gate_enabled  : bool

$feature_monetization_enabled  : bool

$feature_more_soundboard  : bool

$feature_more_stickers  : bool

$feature_news  : bool

$feature_partnered  : bool

$feature_preview_enabled  : bool

$feature_private_threads  : bool

$feature_raid_alerts_disabled  : bool

$feature_raid_alerts_enabled  : bool

$feature_role_icons  : bool

$feature_role_subscriptions_available_for_purchase  : bool

$feature_role_subscriptions_enabled  : bool

$feature_soundboard  : bool

$feature_ticketed_events_enabled  : bool

$feature_vanity_url  : bool

$feature_verified  : bool

$feature_vip_regions  : bool

$feature_welcome_screen_enabled  : bool

$features  : array<string|int, string>

$icon  : string|null

$id  : string

$name  : string

$scriptData  : mixed

Custom script data.

$splash  : string|null

$stickers  : StickerRepository

$attributes  : array<string|int, mixed>

The parts attributes.

$discord  : Discord

The Discord client.

$factory  : Factory

The factory.

$fillable  : array<string|int, mixed>

The parts fillable attributes.

$hidden  : array<string|int, mixed>

Attributes that are hidden from debug info.

$http  : Http

The HTTP client.

$repositories  : array<string|int, mixed>

An array of repositories that can exist in a part.

$repositories_cache  : array<string|int, mixed>

An array of repositories.

$visible  : array<string|int, mixed>

Attributes which are visible from debug info.

Methods

__construct()  : mixed

Create a new part instance.

__debugInfo()  : array<string|int, mixed>

__get()  : mixed

Handles dynamic get calls onto the part.

__serialize()  : array<string|int, mixed>

__set()  : void

Handles dynamic set calls onto the part.

__toString()  : string

Converts the part to a string.

__unserialize()  : void

fetch()  : PromiseInterface<string|int, static>

Fetches any missing information about the part from Discord's servers.

fill()  : void

Fills the parts attributes from an array.

getCreatableAttributes()  : array<string|int, mixed>

Returns the attributes needed to create.

getDiscord()  : Discord

Get the Discord instance that owns this Part.

getIconAttribute()  : string|null

Returns the guilds icon.

getPublicAttributes()  : array<string|int, mixed>

Returns an array of public attributes.

getRawAttributes()  : array<string|int, mixed>

Returns an array of raw attributes.

getRepositoryAttributes()  : array<string|int, mixed>

{@inheritDoc}

getSplashAttribute()  : string|null

Returns the guild splash.

getUpdatableAttributes()  : array<string|int, mixed>

Returns the updatable attributes.

isPartial()  : bool

Whether the part is considered partial i.e. missing information which can be fetched from Discord.

jsonSerialize()  : array<string|int, mixed>

Provides data when the part is encoded into JSON. Used for JsonSerializable.

offsetExists()  : bool

Checks if an attribute exists via key. Used for ArrayAccess.

offsetGet()  : mixed

Gets an attribute via key. Used for ArrayAccess.

offsetSet()  : void

Sets an attribute via key. Used for ArrayAccess.

offsetUnset()  : void

Unsets an attribute via key. Used for ArrayAccess.

serialize()  : string|null

Serializes the data. Used for Serializable.

unserialize()  : void

Unserializes some data and stores it. Used for Serializable.

afterConstruct()  : void

Called after the part has been constructed.

getFeatureAnimatedBannerAttribute()  : bool

getFeatureAnimatedIconAttribute()  : bool

getFeatureApplicationCommandPermissionsV2()  : bool

getFeatureAutoModerationAttribute()  : bool

getFeatureBannerAttribute()  : bool

getFeatureCommunityAttribute()  : bool

getFeatureCreatorMonetizableProvisionalAttribute()  : bool

getFeatureCreatorStorePageAttribute()  : bool

getFeatureDeveloperSupportServerAttribute()  : bool

getFeatureDiscoverableAttribute()  : bool

getFeatureEnhancedRoleColorsAttribute()  : bool

getFeatureFeaturableAttribute()  : bool

getFeatureGuestEnabledAttribute()  : bool

getFeatureHasDirectoryEntryAttribute()  : bool

getFeatureInvitesDisabledAttribute()  : bool

getFeatureInviteSplashAttribute()  : bool

getFeatureLinkedToHubAttribute()  : bool

getFeatureMemberVerificationGateEnabledAttribute()  : bool

getFeatureMonetizationEnabledAttribute()  : bool

getFeatureMoreSoundboardAttribute()  : bool

getFeatureMoreStickersAttribute()  : bool

getFeatureNewsAttribute()  : bool

getFeaturePartneredAttribute()  : bool

getFeaturePreviewEnabledAttribute()  : bool

getFeaturePrivateThreadsAttribute()  : bool

getFeatureRaidAlertsDisabledAttribute()  : bool

getFeatureRaidAlertsEnabledAttribute()  : bool

getFeatureRoleIconsAttribute()  : bool

getFeatureRoleSubscriptionsAvailableForPurchaseAttribute()  : bool

getFeatureRoleSubscriptionsEnabledAttribute()  : bool

getFeatureSoundboardAttribute()  : bool

getFeatureTicketedEventsEnabledAttribute()  : bool

getFeatureVanityUrlAttribute()  : bool

getFeatureVerifiedAttribute()  : bool

getFeatureVipRegionsAttribute()  : bool

getFeatureWelcomeScreenEnabledAttribute()  : bool

getIconHashAttribute()  : string|null

Returns the guild icon hash.

getSplashHashAttribute()  : string|null

Returns the guild splash hash.

makeOptionalAttributes()  : array<string|int, mixed>

Return key-value attributes if it has been filled.

checkForGetMutator()  : string|false

Checks if there is a get mutator present.

checkForSetMutator()  : string|false

Checks if there is a set mutator present.

getAttribute()  : mixed

Gets an attribute on the part.

setAttribute()  : void

Sets an attribute on the part.

studly()  : string

Converts a string to studlyCase.