OBJECT

CommunityPointsChannelSettings

Settings for a channel's Community Points.

GraphQL Schema definition

1 type CommunityPointsChannelSettings {
2 
3 #   Archived community goals for this channel.
4 archivedGoals(first: Int, after: Cursor): CommunityPointsCommunityGoalConnection 
5 
6 #   Automatic rewards for this channel. If no automatic rewards exist, will be an 
7 #   empty array.
8 automaticRewards: [CommunityPointsAutomaticReward!] 
9 
10 #   The default max contribution to a community goal per user per stream.
11 communityGoalMaxContributionPerStream: Int! 
12 
13 #   The default small contribution to a community goal.
14 communityGoalSmallContribution: Int! 
15 
16 #   Single custom reward by the given id for this channel.
17 customReward(id: ID!): CommunityPointsCustomReward 
18 
19 #   Collections of the custom reward templates for this channel.
20 customRewardTemplateCollections: [CommunityPointsCustomRewardTemplateCollection!] 
21 
22 #   Custom rewards for this channel. If no custom rewards exist, will be an empty 
23 #   array.
24 customRewards: [CommunityPointsCustomReward!] 
25 
26 #   The default image for community points.
27 defaultImage: CommunityPointsImage! 
28 
29 #   Properties concerning the user's participation in the Channel Points early 
30 #   access program.
31 earlyAccess: CommunityPointsEarlyAccessSettings @deprecated( reason: "Early Access period is over."  )
32 
33 #   Information on how points are earned by viewers in this channel.
34 earning: CommunityPointsChannelEarningSettings 
35 
36 #   A list of the emote variants (base emote + modifications) that are available for 
37 #   this channel.
38 emoteVariants: [CommunityPointsEmoteVariant!] 
39 
40 #   Non-archived community goals for this channel.
41 goals(includeGoalTypes: [CommunityPointsCommunityGoalType!]): [CommunityPointsCommunityGoal!] 
42 
43 #   The channel's custom community points icon. Null if they have not set an icon.
44 image: CommunityPointsImage 
45 
46 #   Whether the channel is allowed to turn community points on now.
47 isAvailable: Boolean! 
48 
49 #   Whether the channel will be allowed to turn community points on at full public 
50 #   launch.
51 isAvailableAtLaunch: Boolean! @deprecated( reason: "Early Access period is over."  )
52 
53 #   Whether the channel has community points turned on now.
54 isEnabled: Boolean! 
55 
56 #   Whether the channel will have community points turned on at full public launch.
57 isEnabledAtLaunch: Boolean! @deprecated( reason: "Early Access period is over."  )
58 
59 #   The channel's custom community points name. Null if they have not set a name.
60 name: String 
61 
62 #   The amount of points earned for participating in a raid from the channel.
63 raidPointAmount: Int! @deprecated( reason: "Should use earning.raidPoints instead"  )
64 
65 #   A list of Smart Costs acknowledgements.
66 smartCostsAcknowledgements: [SmartCostsAcknowledgement!] 
67 
68 #   A summary of information about unfulfilled redemptions of each custom reward.
69 summarizedRewards: [CommunityPointsRewardSummary!] 
70 
71 #   A list of the progress for all ongoing Update Custom Reward Redemption Statuses 
72 #   requests.
73 updateCustomRewardRedemptionStatusesProgress: [CommunityPointsUpdateCustomRewardRedemptionStatusesProgress!] 
74 
75 }

Required by

ChannelA User's place on Twitch.

1	type CommunityPointsChannelSettings {
2
3	# Archived community goals for this channel.
4	archivedGoals(first: Int, after: Cursor): CommunityPointsCommunityGoalConnection
5
6	# Automatic rewards for this channel. If no automatic rewards exist, will be an
7	# empty array.
8	automaticRewards: [CommunityPointsAutomaticReward!]
9
10	# The default max contribution to a community goal per user per stream.
11	communityGoalMaxContributionPerStream: Int!
12
13	# The default small contribution to a community goal.
14	communityGoalSmallContribution: Int!
15
16	# Single custom reward by the given id for this channel.
17	customReward(id: ID!): CommunityPointsCustomReward
18
19	# Collections of the custom reward templates for this channel.
20	customRewardTemplateCollections: [CommunityPointsCustomRewardTemplateCollection!]
21
22	# Custom rewards for this channel. If no custom rewards exist, will be an empty
23	# array.
24	customRewards: [CommunityPointsCustomReward!]
25
26	# The default image for community points.
27	defaultImage: CommunityPointsImage!
28
29	# Properties concerning the user's participation in the Channel Points early
30	# access program.
31	earlyAccess: CommunityPointsEarlyAccessSettings @deprecated( reason: "Early Access period is over." )
32
33	# Information on how points are earned by viewers in this channel.
34	earning: CommunityPointsChannelEarningSettings
35
36	# A list of the emote variants (base emote + modifications) that are available for
37	# this channel.
38	emoteVariants: [CommunityPointsEmoteVariant!]
39
40	# Non-archived community goals for this channel.
41	goals(includeGoalTypes: [CommunityPointsCommunityGoalType!]): [CommunityPointsCommunityGoal!]
42
43	# The channel's custom community points icon. Null if they have not set an icon.
44	image: CommunityPointsImage
45
46	# Whether the channel is allowed to turn community points on now.
47	isAvailable: Boolean!
48
49	# Whether the channel will be allowed to turn community points on at full public
50	# launch.
51	isAvailableAtLaunch: Boolean! @deprecated( reason: "Early Access period is over." )
52
53	# Whether the channel has community points turned on now.
54	isEnabled: Boolean!
55
56	# Whether the channel will have community points turned on at full public launch.
57	isEnabledAtLaunch: Boolean! @deprecated( reason: "Early Access period is over." )
58
59	# The channel's custom community points name. Null if they have not set a name.
60	name: String
61
62	# The amount of points earned for participating in a raid from the channel.
63	raidPointAmount: Int! @deprecated( reason: "Should use earning.raidPoints instead" )
64
65	# A list of Smart Costs acknowledgements.
66	smartCostsAcknowledgements: [SmartCostsAcknowledgement!]
67
68	# A summary of information about unfulfilled redemptions of each custom reward.
69	summarizedRewards: [CommunityPointsRewardSummary!]
70
71	# A list of the progress for all ongoing Update Custom Reward Redemption Statuses
72	# requests.
73	updateCustomRewardRedemptionStatusesProgress: [CommunityPointsUpdateCustomRewardRedemptionStatusesProgress!]
74
75	}

CommunityPointsChannelSettings

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by