OBJECT

Extension

Twitch Extension.

GraphQL Schema definition

1 type Extension {
2 
3 #   The anchor point the extension expects to render into on the client.
4 anchor: ExtensionAnchor! 
5 
6 #   A list of assets which the extension must have uploaded to the Twitch Extensions 
7 #   CDN.
8 assetURLs: [String!]! 
9 
10 #   The author of the extension as specified by the developer's extension manifest.
11 authorName: String! 
12 
13 #   The bits support level required by the broadcaster for the extension to operate.
14 bitsSupportLevel: ExtensionBitsSupportLevel! 
15 
16 #   The list of categories that the developer has set for the extension.
17 categories: [ExtensionCategory!]! 
18 
19 #   A single challenge condition associated with the specified extension.
20 challengeCondition(
21 input: ExtensionChallengeConditionByIDInput!
22 ): ChallengeCondition 
23 
24 #   The list of challenge condition participants that are associated with this 
25 #   extension for a particular condition participant owner and condition owner.
26 challengeConditionParticipants(
27 first: Int,
28 after: Cursor,
29 input: ExtensionChallengeConditionParticipantsInput!
30 ): ExtensionChallengeConditionParticipantConnection 
31 
32 #   The list of challenge conditions that are associated with this extension.
33 challengeConditions(
34 first: Int,
35 after: Cursor,
36 input: ExtensionChallengeConditionsInput!
37 ): ExtensionChallengeConditionConnection 
38 
39 #   The client ID of the extension. Also used as the non-composite, non-unique ID of 
40 #   an extension internally.
41 clientID: ID! 
42 
43 #   The URL which is used to preset the configuration experience of the extension.
44 configURL: String! @deprecated( reason: "configURL should be captured from the config ExtensionView: Extension.views.config.viewerURL"  )
45 
46 #   The list of games that an extension is content-matched to. This list is managed 
47 #   internally by Twitch.
48 contentMatchedGames: [Game!] 
49 
50 #   The description of the extension specified by the developer's extension manifest
51 #   (max-length: 1024 characters).
52 description: String! 
53 
54 #   The list of games that an extension is associated to. This list is managed by 
55 #   the extension developer.
56 games: [Game!] 
57 
58 #   Whether the extension developer has turned on chat support for this extension.
59 hasChatSupport: Boolean! 
60 
61 #   Represents whether or not the developer of the extension would like to provide 
62 #   users with
63 #   the ability to link their identity with the extension.
64 hasIdentityLinking: Boolean! 
65 
66 #   The extension icon URLs used to visually represent the extension.
67 iconURLs: ExtensionIcons! 
68 
69 #   The extension ID which is a composite form of :.
70 id: ID! 
71 
72 #   Represents whether or not the extension supports bits monetization.
73 isBitsEnabled: Boolean! 
74 
75 #   The URL which is used to preset the live-dashboard experience of the extension.
76 liveConfigURL: String! @deprecated( reason: "liveConfigURL should be captured from the liveConfig ExtensionView: Extension.views.liveConfig.viewerURL"  )
77 
78 #   The name of the extension specified by the developer's extension manifest
79 #   (max-length: 40 characters).
80 name: String! 
81 
82 #   The panel height specified by the developer's extension manifest -or- 300.
83 panelHeight: Int! @deprecated( reason: "panelHeight should be captured from the panel ExtensionView: Extension.views.panel.height"  )
84 
85 #   The link to the extension's privacy policy as specified by the developer's 
86 #   extension manifest.
87 privacyPolicyURL: String! 
88 
89 #   Screenshots of the URL used to showcase the extension on extension details 
90 #   pages.
91 screenshotURLs: [String!]! 
92 
93 #   Represents whether the requesting user is able to install the extension.
94 self: ExtensionSelfConnection 
95 
96 #   The sku of the extension for monetizable extensions.
97 sku: String! 
98 
99 #   The current state of the extension in our approval process.
100 state: ExtensionState! 
101 
102 #   The subscription support level required by the broadcaster for the extension to 
103 #   operate.
104 subscriptionsSupportLevel: ExtensionSubscriptionsSupportLevel! 
105 
106 #   The summary of the extension specified by the developer's extension manifest
107 #   (max-length: 140 characters).
108 summary: String! 
109 
110 #   The support contact email as specified by the developer's extension manifest.
111 supportEmail: String! 
112 
113 #   End-user license agreement terms of service URL.
114 termsURL: String! 
115 
116 #   The vendor code of the extension for monetizable extensions.
117 vendorCode: String! 
118 
119 #   The current version of the extension specified by the developer's extension 
120 #   manifest.
121 version: String! 
122 
123 #   The URL which is used to preset the viewer experience of the extension.
124 viewerURL: String! @deprecated( reason: "viewerURL should be captured from the ExtensionView corresponding with the Extension's specified anchor"  )
125 
126 #   The UI configurations of each supported view of the extension.
127 views: ExtensionViews! 
128 
129 #   The list of URLs an extension can link to while loaded in the configuration 
130 #   experience.
131 whitelistedConfigURLs: [String!]! 
132 
133 #   The list of URLs a panel extension can link to while loaded in the viewer 
134 #   experience.
135 whitelistedPanelURLs: [String!]! 
136 
137 }

1	type Extension {
2
3	# The anchor point the extension expects to render into on the client.
4	anchor: ExtensionAnchor!
5
6	# A list of assets which the extension must have uploaded to the Twitch Extensions
7	# CDN.
8	assetURLs: [String!]!
9
10	# The author of the extension as specified by the developer's extension manifest.
11	authorName: String!
12
13	# The bits support level required by the broadcaster for the extension to operate.
14	bitsSupportLevel: ExtensionBitsSupportLevel!
15
16	# The list of categories that the developer has set for the extension.
17	categories: [ExtensionCategory!]!
18
19	# A single challenge condition associated with the specified extension.
20	challengeCondition(
21	input: ExtensionChallengeConditionByIDInput!
22	): ChallengeCondition
23
24	# The list of challenge condition participants that are associated with this
25	# extension for a particular condition participant owner and condition owner.
26	challengeConditionParticipants(
27	first: Int,
28	after: Cursor,
29	input: ExtensionChallengeConditionParticipantsInput!
30	): ExtensionChallengeConditionParticipantConnection
31
32	# The list of challenge conditions that are associated with this extension.
33	challengeConditions(
34	first: Int,
35	after: Cursor,
36	input: ExtensionChallengeConditionsInput!
37	): ExtensionChallengeConditionConnection
38
39	# The client ID of the extension. Also used as the non-composite, non-unique ID of
40	# an extension internally.
41	clientID: ID!
42
43	# The URL which is used to preset the configuration experience of the extension.
44	configURL: String! @deprecated( reason: "configURL should be captured from the config ExtensionView: Extension.views.config.viewerURL" )
45
46	# The list of games that an extension is content-matched to. This list is managed
47	# internally by Twitch.
48	contentMatchedGames: [Game!]
49
50	# The description of the extension specified by the developer's extension manifest
51	# (max-length: 1024 characters).
52	description: String!
53
54	# The list of games that an extension is associated to. This list is managed by
55	# the extension developer.
56	games: [Game!]
57
58	# Whether the extension developer has turned on chat support for this extension.
59	hasChatSupport: Boolean!
60
61	# Represents whether or not the developer of the extension would like to provide
62	# users with
63	# the ability to link their identity with the extension.
64	hasIdentityLinking: Boolean!
65
66	# The extension icon URLs used to visually represent the extension.
67	iconURLs: ExtensionIcons!
68
69	# The extension ID which is a composite form of :.
70	id: ID!
71
72	# Represents whether or not the extension supports bits monetization.
73	isBitsEnabled: Boolean!
74
75	# The URL which is used to preset the live-dashboard experience of the extension.
76	liveConfigURL: String! @deprecated( reason: "liveConfigURL should be captured from the liveConfig ExtensionView: Extension.views.liveConfig.viewerURL" )
77
78	# The name of the extension specified by the developer's extension manifest
79	# (max-length: 40 characters).
80	name: String!
81
82	# The panel height specified by the developer's extension manifest -or- 300.
83	panelHeight: Int! @deprecated( reason: "panelHeight should be captured from the panel ExtensionView: Extension.views.panel.height" )
84
85	# The link to the extension's privacy policy as specified by the developer's
86	# extension manifest.
87	privacyPolicyURL: String!
88
89	# Screenshots of the URL used to showcase the extension on extension details
90	# pages.
91	screenshotURLs: [String!]!
92
93	# Represents whether the requesting user is able to install the extension.
94	self: ExtensionSelfConnection
95
96	# The sku of the extension for monetizable extensions.
97	sku: String!
98
99	# The current state of the extension in our approval process.
100	state: ExtensionState!
101
102	# The subscription support level required by the broadcaster for the extension to
103	# operate.
104	subscriptionsSupportLevel: ExtensionSubscriptionsSupportLevel!
105
106	# The summary of the extension specified by the developer's extension manifest
107	# (max-length: 140 characters).
108	summary: String!
109
110	# The support contact email as specified by the developer's extension manifest.
111	supportEmail: String!
112
113	# End-user license agreement terms of service URL.
114	termsURL: String!
115
116	# The vendor code of the extension for monetizable extensions.
117	vendorCode: String!
118
119	# The current version of the extension specified by the developer's extension
120	# manifest.
121	version: String!
122
123	# The URL which is used to preset the viewer experience of the extension.
124	viewerURL: String! @deprecated( reason: "viewerURL should be captured from the ExtensionView corresponding with the Extension's specified anchor" )
125
126	# The UI configurations of each supported view of the extension.
127	views: ExtensionViews!
128
129	# The list of URLs an extension can link to while loaded in the configuration
130	# experience.
131	whitelistedConfigURLs: [String!]!
132
133	# The list of URLs a panel extension can link to while loaded in the viewer
134	# experience.
135	whitelistedPanelURLs: [String!]!
136
137	}

Extension

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by