payload

Documentation

Index

• type AccountSettingsQuery
  • func (p *AccountSettingsQuery) Encode() ([]byte, error)
• type ContextInfo
• type DMMessageDeleteMutationVariables
• type DMRequestQuery
  • func (p DMRequestQuery) Default() DMRequestQuery
  • func (p DMRequestQuery) Encode() ([]byte, error)
• type EditDirectMessagePayload
  • func (p *EditDirectMessagePayload) Encode() ([]byte, error)
• type EventNamespace
• type GetDMPermissionsQuery
  • func (p *GetDMPermissionsQuery) Encode() ([]byte, error)
• type GraphQLPayload
  • func (p *GraphQLPayload) Encode() ([]byte, error)
• type JotClientEventPayload
  • func (p *JotClientEventPayload) Encode() ([]byte, error)
• type JotDebugLogPayload
• type JotDebugLoggingCategory
• type JotLogPayload
  • func (p *JotLogPayload) ToJSON() ([]byte, error)
• type JotLoggingCategory
• type LabelType
• type MarkConversationReadQuery
  • func (p *MarkConversationReadQuery) Encode() ([]byte, error)
• type MediaCategory
• type MigrationRequestPayload
• type PinAndUnpinConversationVariables
• type ReactionActionPayload
  • func (p *ReactionActionPayload) Encode() ([]byte, error)
• type SearchQuery
  • func (p *SearchQuery) Encode() ([]byte, error)
• type SearchResultType
• type SendDirectMessagePayload
  • func (p *SendDirectMessagePayload) Encode() ([]byte, error)
• type SendTypingNotificationVariables
• type UploadMediaQuery
  • func (p *UploadMediaQuery) Encode() ([]byte, error)
• type WebPushConfigPayload

Types

type AccountSettingsQuery

type AccountSettingsQuery struct {
	IncludeExtSharingAudiospacesListeningDataWithFollowers bool   `url:"include_ext_sharing_audiospaces_listening_data_with_followers"`
	IncludeMentionFilter                                   bool   `url:"include_mention_filter"`
	IncludeNSFWUserFlag                                    bool   `url:"include_nsfw_user_flag"`
	IncludeNSFWAdminFlag                                   bool   `url:"include_nsfw_admin_flag"`
	IncludeRankedTimeline                                  bool   `url:"include_ranked_timeline"`
	IncludeAltTextCompose                                  bool   `url:"include_alt_text_compose"`
	Ext                                                    string `url:"ext"`
	IncludeCountryCode                                     bool   `url:"include_country_code"`
	IncludeExtDMNSFWMediaFilter                            bool   `url:"include_ext_dm_nsfw_media_filter"`
}

func (*AccountSettingsQuery) Encode

func (p *AccountSettingsQuery) Encode() ([]byte, error)

type ContextInfo

type ContextInfo string

const (
	CONTEXT_FETCH_DM_CONVERSATION         ContextInfo = "FETCH_DM_CONVERSATION"
	CONTEXT_FETCH_DM_CONVERSATION_HISTORY ContextInfo = "FETCH_DM_CONVERSATION_HISTORY"
)

type DMMessageDeleteMutationVariables

type DMMessageDeleteMutationVariables struct {
	MessageID string `json:"messageId,omitempty"`
	RequestID string `json:"requestId,omitempty"`
}

type DMRequestQuery

type DMRequestQuery struct {
	ActiveConversationID                string      `url:"active_conversation_id,omitempty"`
	Cursor                              string      `url:"cursor,omitempty"`
	Count                               int         `url:"count,omitempty"`
	Context                             ContextInfo `url:"context,omitempty"`
	MaxID                               string      `url:"max_id,omitempty"` // when fetching messages, this is the message id
	MinID                               string      `url:"min_id,omitempty"`
	NSFWFilteringEnabled                bool        `url:"nsfw_filtering_enabled"`
	IncludeProfileInterstitialType      int         `url:"include_profile_interstitial_type"`
	IncludeBlocking                     int         `url:"include_blocking"`
	IncludeConversationInfo             bool        `url:"include_conversation_info"`
	IncludeBlockedBy                    int         `url:"include_blocked_by"`
	IncludeFollowedBy                   int         `url:"include_followed_by"`
	IncludeWantRetweets                 int         `url:"include_want_retweets"`
	IncludeMuteEdge                     int         `url:"include_mute_edge"`
	IncludeCanDM                        int         `url:"include_can_dm"`
	IncludeCanMediaTag                  int         `url:"include_can_media_tag"`
	IncludeExtIsBlueVerified            int         `url:"include_ext_is_blue_verified"`
	IncludeExtVerifiedType              int         `url:"include_ext_verified_type"`
	IncludeExtProfileImageShape         int         `url:"include_ext_profile_image_shape"`
	SkipStatus                          int         `url:"skip_status"`
	DMSecretConversationsEnabled        bool        `url:"dm_secret_conversations_enabled"`
	KRSRegistrationEnabled              bool        `url:"krs_registration_enabled"`
	CardsPlatform                       string      `url:"cards_platform"`
	IncludeCards                        int         `url:"include_cards"`
	IncludeExtAltText                   bool        `url:"include_ext_alt_text"`
	IncludeExtLimitedActionResults      bool        `url:"include_ext_limited_action_results"`
	IncludeQuoteCount                   bool        `url:"include_quote_count"`
	IncludeReplyCount                   int         `url:"include_reply_count"`
	TweetMode                           string      `url:"tweet_mode"`
	IncludeExtViews                     bool        `url:"include_ext_views"`
	DMUsers                             bool        `url:"dm_users"`
	IncludeGroups                       bool        `url:"include_groups"`
	IncludeInboxTimelines               bool        `url:"include_inbox_timelines"`
	IncludeExtMediaColor                bool        `url:"include_ext_media_color"`
	SupportsReactions                   bool        `url:"supports_reactions"`
	IncludeExtEditControl               bool        `url:"include_ext_edit_control"`
	IncludeExtBusinessAffiliationsLabel bool        `url:"include_ext_business_affiliations_label"`
	Ext                                 string      `url:"ext"`
}

func (DMRequestQuery) Default

func (p DMRequestQuery) Default() DMRequestQuery

func (DMRequestQuery) Encode

func (p DMRequestQuery) Encode() ([]byte, error)

type EditDirectMessagePayload

type EditDirectMessagePayload struct {
	ConversationID string `url:"conversation_id,omitempty"`
	RequestID      string `url:"request_id,omitempty"`
	DMID           string `url:"dm_id,omitempty"` // used to specify a message, specifically for editing
	Text           string `url:"text"`
}

func (*EditDirectMessagePayload) Encode

func (p *EditDirectMessagePayload) Encode() ([]byte, error)

type EventNamespace

type EventNamespace struct {
	Page   string `json:"page,omitempty"`
	Action string `json:"action,omitempty"`
	Client string `json:"client,omitempty"`
}

type GetDMPermissionsQuery

type GetDMPermissionsQuery struct {
	// seperated by commas: userid1,userid2,userid3
	RecipientIDs string `url:"recipient_ids"`
	DMUsers      bool   `url:"dm_users"`
}

func (*GetDMPermissionsQuery) Encode

func (p *GetDMPermissionsQuery) Encode() ([]byte, error)

type GraphQLPayload

type GraphQLPayload struct {
	Variables interface{} `json:"variables,omitempty"`
	QueryID   string      `json:"queryId,omitempty"`
}

func (*GraphQLPayload) Encode

func (p *GraphQLPayload) Encode() ([]byte, error)

type JotClientEventPayload

type JotClientEventPayload struct {
	Category JotLoggingCategory `url:"category,omitempty"`
	Debug    bool               `url:"debug,omitempty"`
	Log      string             `url:"log"`
}

func (*JotClientEventPayload) Encode

func (p *JotClientEventPayload) Encode() ([]byte, error)

type JotDebugLogPayload

type JotDebugLogPayload struct {
	Category                          JotDebugLoggingCategory `json:"_category_,omitempty"`
	FormatVersion                     int                     `json:"format_version,omitempty"`
	TriggeredOn                       int64                   `json:"triggered_on,omitempty"`
	Items                             []any                   `json:"items,omitempty"`
	EventNamespace                    EventNamespace          `json:"event_namespace,omitempty"`
	ClientEventSequenceStartTimestamp int64                   `json:"client_event_sequence_start_timestamp,omitempty"`
	ClientEventSequenceNumber         int                     `json:"client_event_sequence_number,omitempty"`
	ClientAppID                       string                  `json:"client_app_id,omitempty"`
}

type JotDebugLoggingCategory

type JotDebugLoggingCategory string

const (
	JotDebugLoggingCategoryClientEvent JotDebugLoggingCategory = "client_event"
)

type JotLogPayload

type JotLogPayload struct {
	Description string `json:"description,omitempty"`
	Product     string `json:"product,omitempty"`
	DurationMS  int64  `json:"duration_ms,omitempty"`
	EventValue  int64  `json:"event_value,omitempty"`
}

func (*JotLogPayload) ToJSON

func (p *JotLogPayload) ToJSON() ([]byte, error)

type JotLoggingCategory

type JotLoggingCategory string

const (
	JotLoggingCategoryPerftown JotLoggingCategory = "perftown"
)

type LabelType

type LabelType string

const (
	LABEL_TYPE_PINNED LabelType = "Pinned"
)

type MarkConversationReadQuery

type MarkConversationReadQuery struct {
	ConversationID  string `url:"conversationId"`
	LastReadEventID string `url:"last_read_event_id"`
}

func (*MarkConversationReadQuery) Encode

func (p *MarkConversationReadQuery) Encode() ([]byte, error)

type MediaCategory

type MediaCategory string

const (
	MEDIA_CATEGORY_DM_IMAGE MediaCategory = "dm_image"
	MEDIA_CATEGORY_DM_VIDEO MediaCategory = "dm_video"
	MEDIA_CATEGORY_DM_GIF   MediaCategory = "dm_gif"
)

type MigrationRequestPayload

type MigrationRequestPayload struct {
	Tok  string `url:"tok"`
	Data string `url:"data"`
}

type PinAndUnpinConversationVariables

type PinAndUnpinConversationVariables struct {
	ConversationID string    `json:"conversation_id,omitempty"`
	LabelType      LabelType `json:"label_type,omitempty"`
	Label          LabelType `json:"label,omitempty"`
}

type ReactionActionPayload

type ReactionActionPayload struct {
	ConversationID string   `json:"conversationId"`
	MessageID      string   `json:"messageId"`
	ReactionTypes  []string `json:"reactionTypes"`
	EmojiReactions []string `json:"emojiReactions"`
}

func (*ReactionActionPayload) Encode

func (p *ReactionActionPayload) Encode() ([]byte, error)

type SearchQuery

type SearchQuery struct {
	IncludeExtIsBlueVerified    string           `url:"include_ext_is_blue_verified"`
	IncludeExtVerifiedType      string           `url:"include_ext_verified_type"`
	IncludeExtProfileImageShape string           `url:"include_ext_profile_image_shape"`
	Query                       string           `url:"q"`
	Src                         string           `url:"src"`
	ResultType                  SearchResultType `url:"result_type"`
}

func (*SearchQuery) Encode

func (p *SearchQuery) Encode() ([]byte, error)

type SearchResultType

type SearchResultType string

const (
	SEARCH_RESULT_TYPE_USERS SearchResultType = "users"
)

type SendDirectMessagePayload

type SendDirectMessagePayload struct {
	ConversationID    string `json:"conversation_id,omitempty"`
	MediaID           string `json:"media_id,omitempty"`
	ReplyToDMID       string `json:"reply_to_dm_id,omitempty"`
	RecipientIDs      bool   `json:"recipient_ids"`
	RequestID         string `json:"request_id,omitempty"`
	Text              string `json:"text"`
	CardsPlatform     string `json:"cards_platform,omitempty"`
	IncludeCards      int    `json:"include_cards,omitempty"`
	IncludeQuoteCount bool   `json:"include_quote_count"`
	DMUsers           bool   `json:"dm_users"`
}

func (*SendDirectMessagePayload) Encode

func (p *SendDirectMessagePayload) Encode() ([]byte, error)

type SendTypingNotificationVariables

type SendTypingNotificationVariables struct {
	ConversationID string `json:"conversationId,omitempty"`
}

type UploadMediaQuery

type UploadMediaQuery struct {
	Command         string        `url:"command,omitempty"`
	TotalBytes      int           `url:"total_bytes,omitempty"`
	SourceURL       string        `url:"source_url,omitempty"`
	MediaID         string        `url:"media_id,omitempty"`
	VideoDurationMS float32       `url:"video_duration_ms,omitempty"`
	OriginalMD5     string        `url:"original_md5,omitempty"`
	SegmentIndex    int           `url:"segment_index,omitempty"`
	MediaType       string        `url:"media_type,omitempty"`
	MediaCategory   MediaCategory `url:"media_category,omitempty"`
}

func (*UploadMediaQuery) Encode

func (p *UploadMediaQuery) Encode() ([]byte, error)

type WebPushConfigPayload

type WebPushConfigPayload struct {
	Token  string `json:"token"`
	P256DH string `json:"encryption_key1"`
	Auth   string `json:"encryption_key2"`

	OSVersion string `json:"os_version"`
	UDID      string `json:"udid"`
	Locale    string `json:"locale"`

	Env             int `json:"env"`
	ProtocolVersion int `json:"protocol_version"`
}