github.com/diamondburned/arikawa/v2@v2.1.0/state/events.go (about)

     1  package state
     2  
     3  import "github.com/diamondburned/arikawa/v2/gateway"
     4  
     5  // events that originated from GuildCreate:
     6  type (
     7  	// GuildReady gets fired for every guild the bot/user is in, as found in
     8  	// the Ready event.
     9  	//
    10  	// Guilds that are unavailable when connecting, will not trigger a
    11  	// GuildReadyEvent, until they become available again.
    12  	GuildReadyEvent struct {
    13  		*gateway.GuildCreateEvent
    14  	}
    15  
    16  	// GuildAvailableEvent gets fired when a guild becomes available again,
    17  	// after being previously declared unavailable through a
    18  	// GuildUnavailableEvent. This event will not be fired for guilds that
    19  	// were already unavailable when connecting to the gateway.
    20  	GuildAvailableEvent struct {
    21  		*gateway.GuildCreateEvent
    22  	}
    23  
    24  	// GuildJoinEvent gets fired if the bot/user joins a guild.
    25  	GuildJoinEvent struct {
    26  		*gateway.GuildCreateEvent
    27  	}
    28  )
    29  
    30  // events that originated from GuildDelete:
    31  type (
    32  	// GuildLeaveEvent gets fired if the bot/user left a guild, was removed
    33  	// or the owner deleted the guild.
    34  	GuildLeaveEvent struct {
    35  		*gateway.GuildDeleteEvent
    36  	}
    37  
    38  	// GuildUnavailableEvent gets fired if a guild becomes unavailable.
    39  	GuildUnavailableEvent struct {
    40  		*gateway.GuildDeleteEvent
    41  	}
    42  )