OBJECT

CommunityPointsCommunityGoal

Community goal.

GraphQL Schema definition

1 type CommunityPointsCommunityGoal {
2 
3 #   The amount of community points that this goal needs to succeed.
4 amountNeeded: Int! 
5 
6 #   The background color of this goal. Should be a hex color string, for example 
7 #   "FF0000".
8 backgroundColor: String! 
9 
10 #   The default image of community goals.
11 defaultImage: CommunityPointsImage! 
12 
13 #   The description of this goal.
14 description: String 
15 
16 #   The *initial* duration the streamer set for the goal.
17 #   Only really used during the UNSTARTED state; once the goal is started
18 #   the endedAt timestamp is populated (and updated for extended deadlines).
19 durationDays: Int! 
20 
21 #   When the goal ended / will end.
22 endedAt: Time 
23 
24 #   The id of the goal.
25 id: ID! 
26 
27 #   The image of the goal.
28 image: CommunityPointsImage 
29 
30 #   If this goal is available to be contributed to.
31 #   true when the goal is active and the streamer is live.
32 #   For MLP, this is just whether the channel is live.
33 isInStock: Boolean! 
34 
35 #   The max per stream, per user contribution limit.
36 perStreamUserMaximumContribution: Int! 
37 
38 #   The total points contributed to this goal.
39 pointsContributed: Int! 
40 
41 #   The small contribution needed to contribute to the goal. Contribution can only 
42 #   be
43 #   less than this amount if the goal has less than this amount left to complete or 
44 #   if
45 #   the viewer has less than this amount to be able to contribute.
46 smallContribution: Int! 
47 
48 #   When the goal started.
49 startedAt: Time 
50 
51 #   The current status of this goal.
52 status: CommunityPointsCommunityGoalStatus! 
53 
54 #   The title of this goal.
55 title: String! 
56 
57 #   The type of this goal.
58 type: CommunityPointsCommunityGoalType! 
59 
60 }

1	type CommunityPointsCommunityGoal {
2
3	# The amount of community points that this goal needs to succeed.
4	amountNeeded: Int!
5
6	# The background color of this goal. Should be a hex color string, for example
7	# "FF0000".
8	backgroundColor: String!
9
10	# The default image of community goals.
11	defaultImage: CommunityPointsImage!
12
13	# The description of this goal.
14	description: String
15
16	# The initial duration the streamer set for the goal.
17	# Only really used during the UNSTARTED state; once the goal is started
18	# the endedAt timestamp is populated (and updated for extended deadlines).
19	durationDays: Int!
20
21	# When the goal ended / will end.
22	endedAt: Time
23
24	# The id of the goal.
25	id: ID!
26
27	# The image of the goal.
28	image: CommunityPointsImage
29
30	# If this goal is available to be contributed to.
31	# true when the goal is active and the streamer is live.
32	# For MLP, this is just whether the channel is live.
33	isInStock: Boolean!
34
35	# The max per stream, per user contribution limit.
36	perStreamUserMaximumContribution: Int!
37
38	# The total points contributed to this goal.
39	pointsContributed: Int!
40
41	# The small contribution needed to contribute to the goal. Contribution can only
42	# be
43	# less than this amount if the goal has less than this amount left to complete or
44	# if
45	# the viewer has less than this amount to be able to contribute.
46	smallContribution: Int!
47
48	# When the goal started.
49	startedAt: Time
50
51	# The current status of this goal.
52	status: CommunityPointsCommunityGoalStatus!
53
54	# The title of this goal.
55	title: String!
56
57	# The type of this goal.
58	type: CommunityPointsCommunityGoalType!
59
60	}

CommunityPointsCommunityGoal

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by