OBJECT

UserSelfConnection

Subjective data on another User (user/channel) for the current user.

GraphQL Schema definition

1 type UserSelfConnection {
2 
3 #   The badges which are available for the authenticated user to select for use on 
4 #   another user's streams and videos.
5 availableBadges: [Badge] 
6 
7 #   Ban status of the authenticated user with respect to this user's channel.
8 banStatus: ChatRoomBanStatus 
9 
10 #   bitsBadge contains information about bits badge progression in a channel.
11 #   This field can only be requested if an OAuth token is supplied with the request.
12 bitsBadge: UserSelfBitsBadge 
13 
14 #   The bits leaderboard entry shows the current user's entry in the
15 #   channel's leaderboard. It does not show context entries around it.
16 bitsLeaderboardEntry: BitsLeaderboardEntry @deprecated( reason: "use user.self.bitsLeaderboardItem instead."  )
17 
18 #   The bits leaderboard item shows the current user's entry in the
19 #   channel's leaderboard. It does not show context entries around it.
20 bitsLeaderboardItem: BitsLeaderboardItem 
21 
22 #   The bits leaderboard position shows the curreent users rank
23 #   and the surrounding users in the current channel.
24 bitsLeaderboardPosition: BitsLeaderboard 
25 
26 #   Whether or not the authenticated user can follow this user.
27 canFollow: Boolean! 
28 
29 #   CanGift relationship between the authenticated user, another user, and a 
30 #   product.
31 #   True is the authenticated user can gift the product to the other user.
32 canGift(
33 product: String!
34 ): Boolean! @deprecated( reason: "Transitioning to SubscriptionProductSelfConnection instead"  )
35 
36 #   CanGiftInChannel relationship between the authenticated user and a product.
37 #   True is the authenticated user is allowed to send gifts in this channel.
38 canGiftInChannel(
39 product: String!
40 ): Boolean! @deprecated( reason: "Transitioning to SubscriptionProductSelfConnection instead"  )
41 
42 #   Checks if the authenticated user can subscribe to this channel via Prime.
43 canPrimeSubscribe: Boolean! 
44 
45 #   Whether the authenticated user has permission to redeem a subscription to this 
46 #   Channel.
47 #   Return Values are.
48 #   1) Null - The Channel to which the User is subscribed to is not supporting any 
49 #   subscription redemption.
50 #   2) False - The User has already utilized their redemption to the channel 
51 #   offering subscription redemption.
52 #   2) True - The User can use the subscription redemption offered by the channel.
53 canRedeemSubscription: Boolean 
54 
55 #   The list of celebration products available for the authenticated user to 
56 #   purchase in this channel.
57 celebrationProducts: [CelebrationProduct] 
58 
59 #   If the authenticated user cannot chat in this channel, a list of reasons.
60 #   Null if the user can chat.
61 chatRestrictedReasons: [ChatRestrictedReason!] 
62 
63 #   Lists the chat badges that should be displayed by the user's display name in
64 #   features on a particular user's channel (i.e. chat, feeds).
65 #   Includes the following badges:
66 #   - global authority (staff/admin/global mod)
67 #   - channel authority (broadcaster/mod)
68 #   - subscriber
69 #   - channel selected (bits) or global selected (prime, turbo, ...).
70 displayBadges: [Badge]! 
71 
72 #   A follower relationship between the authenticated user and another user.
73 #   Null if the relationship does not exist.
74 follower: FollowerEdge 
75 
76 #   The friendship-type relationship (friendship, incoming friend request, outgoing 
77 #   friend request) between the
78 #   authenticated user and another user. Null if no friendship-type relationship 
79 #   exists.
80 friendship: FriendRelationship 
81 
82 #   True if the authenticated user has joined this channel.
83 isChannelMember: Boolean 
84 
85 #   Whether or not the authenticated user is editor of another user's channel.
86 isEditor: Boolean 
87 
88 #   Whether or not the authenticated user is a founder badge owner of another user's 
89 #   channel.
90 isFounder: Boolean 
91 
92 #   Whether or not the authenticated user is a moderator of another user's channel.
93 isModerator: Boolean 
94 
95 #   Whether or not the authenticated user is a VIP of another user's channel.
96 isVIP: Boolean 
97 
98 #   The timestamp of the last time the authenticated user sent a chat message in 
99 #   another user's channel within the last 30 minutes.
100 #   Null if the authenticated user has not chatted in the channel in the last 30 
101 #   minutes.
102 lastRecentChatMessageAt: Time 
103 
104 #   Information about the authenticated user's Prime subscription credit benefit.
105 primeSubCreditBenefit: PrimeSubCreditBenefit 
106 
107 #   The most recent resub token to use for sending a special message.
108 #   If no notification is pending this will be null.
109 resubNotification: ResubNotification 
110 
111 #   Lists ritual tokens that can be requested or displayed to the user in another 
112 #   user's channel.
113 ritualTokens: [RitualToken!] 
114 
115 #   The badge the authenticated user selected for use on another user's streams and 
116 #   videos.
117 selectedBadge: Badge 
118 
119 #   Stucco packs that are available to viewers of a broadcaster.
120 stuccoPacksViewer: [StuccoPack] 
121 
122 #   The current subscriber badge that a user would have if subscribed & remaining 
123 #   locked subscriber badges with progress.
124 subscriberBadgeProgress(limit: Int): [SubscriberBadgeProgress!] 
125 
126 #   The subscription benefit relationship between the authenticated user and another 
127 #   user.
128 #   Null if the authenticated user is not subscribed to the other user.
129 subscriptionBenefit: SubscriptionBenefit 
130 
131 #   The number of gift subscriptions that the authenticated user has given to other 
132 #   users in this channel.
133 subscriptionGiftCount: Int 
134 
135 #   Subscription tenure data for the user to this channel.
136 subscriptionTenure(tenureMethod: SubscriptionTenureMethod!): SubscriptionTenure 
137 
138 #   Whether the authenticated user can send or receive Whispers to/from another 
139 #   user.
140 whisperPermissions: WhisperPermissions 
141 
142 }

Required by

UserTwitch user.

1	type UserSelfConnection {
2
3	# The badges which are available for the authenticated user to select for use on
4	# another user's streams and videos.
5	availableBadges: [Badge]
6
7	# Ban status of the authenticated user with respect to this user's channel.
8	banStatus: ChatRoomBanStatus
9
10	# bitsBadge contains information about bits badge progression in a channel.
11	# This field can only be requested if an OAuth token is supplied with the request.
12	bitsBadge: UserSelfBitsBadge
13
14	# The bits leaderboard entry shows the current user's entry in the
15	# channel's leaderboard. It does not show context entries around it.
16	bitsLeaderboardEntry: BitsLeaderboardEntry @deprecated( reason: "use user.self.bitsLeaderboardItem instead." )
17
18	# The bits leaderboard item shows the current user's entry in the
19	# channel's leaderboard. It does not show context entries around it.
20	bitsLeaderboardItem: BitsLeaderboardItem
21
22	# The bits leaderboard position shows the curreent users rank
23	# and the surrounding users in the current channel.
24	bitsLeaderboardPosition: BitsLeaderboard
25
26	# Whether or not the authenticated user can follow this user.
27	canFollow: Boolean!
28
29	# CanGift relationship between the authenticated user, another user, and a
30	# product.
31	# True is the authenticated user can gift the product to the other user.
32	canGift(
33	product: String!
34	): Boolean! @deprecated( reason: "Transitioning to SubscriptionProductSelfConnection instead" )
35
36	# CanGiftInChannel relationship between the authenticated user and a product.
37	# True is the authenticated user is allowed to send gifts in this channel.
38	canGiftInChannel(
39	product: String!
40	): Boolean! @deprecated( reason: "Transitioning to SubscriptionProductSelfConnection instead" )
41
42	# Checks if the authenticated user can subscribe to this channel via Prime.
43	canPrimeSubscribe: Boolean!
44
45	# Whether the authenticated user has permission to redeem a subscription to this
46	# Channel.
47	# Return Values are.
48	# 1) Null - The Channel to which the User is subscribed to is not supporting any
49	# subscription redemption.
50	# 2) False - The User has already utilized their redemption to the channel
51	# offering subscription redemption.
52	# 2) True - The User can use the subscription redemption offered by the channel.
53	canRedeemSubscription: Boolean
54
55	# The list of celebration products available for the authenticated user to
56	# purchase in this channel.
57	celebrationProducts: [CelebrationProduct]
58
59	# If the authenticated user cannot chat in this channel, a list of reasons.
60	# Null if the user can chat.
61	chatRestrictedReasons: [ChatRestrictedReason!]
62
63	# Lists the chat badges that should be displayed by the user's display name in
64	# features on a particular user's channel (i.e. chat, feeds).
65	# Includes the following badges:
66	# - global authority (staff/admin/global mod)
67	# - channel authority (broadcaster/mod)
68	# - subscriber
69	# - channel selected (bits) or global selected (prime, turbo, ...).
70	displayBadges: [Badge]!
71
72	# A follower relationship between the authenticated user and another user.
73	# Null if the relationship does not exist.
74	follower: FollowerEdge
75
76	# The friendship-type relationship (friendship, incoming friend request, outgoing
77	# friend request) between the
78	# authenticated user and another user. Null if no friendship-type relationship
79	# exists.
80	friendship: FriendRelationship
81
82	# True if the authenticated user has joined this channel.
83	isChannelMember: Boolean
84
85	# Whether or not the authenticated user is editor of another user's channel.
86	isEditor: Boolean
87
88	# Whether or not the authenticated user is a founder badge owner of another user's
89	# channel.
90	isFounder: Boolean
91
92	# Whether or not the authenticated user is a moderator of another user's channel.
93	isModerator: Boolean
94
95	# Whether or not the authenticated user is a VIP of another user's channel.
96	isVIP: Boolean
97
98	# The timestamp of the last time the authenticated user sent a chat message in
99	# another user's channel within the last 30 minutes.
100	# Null if the authenticated user has not chatted in the channel in the last 30
101	# minutes.
102	lastRecentChatMessageAt: Time
103
104	# Information about the authenticated user's Prime subscription credit benefit.
105	primeSubCreditBenefit: PrimeSubCreditBenefit
106
107	# The most recent resub token to use for sending a special message.
108	# If no notification is pending this will be null.
109	resubNotification: ResubNotification
110
111	# Lists ritual tokens that can be requested or displayed to the user in another
112	# user's channel.
113	ritualTokens: [RitualToken!]
114
115	# The badge the authenticated user selected for use on another user's streams and
116	# videos.
117	selectedBadge: Badge
118
119	# Stucco packs that are available to viewers of a broadcaster.
120	stuccoPacksViewer: [StuccoPack]
121
122	# The current subscriber badge that a user would have if subscribed & remaining
123	# locked subscriber badges with progress.
124	subscriberBadgeProgress(limit: Int): [SubscriberBadgeProgress!]
125
126	# The subscription benefit relationship between the authenticated user and another
127	# user.
128	# Null if the authenticated user is not subscribed to the other user.
129	subscriptionBenefit: SubscriptionBenefit
130
131	# The number of gift subscriptions that the authenticated user has given to other
132	# users in this channel.
133	subscriptionGiftCount: Int
134
135	# Subscription tenure data for the user to this channel.
136	subscriptionTenure(tenureMethod: SubscriptionTenureMethod!): SubscriptionTenure
137
138	# Whether the authenticated user can send or receive Whispers to/from another
139	# user.
140	whisperPermissions: WhisperPermissions
141
142	}

UserSelfConnection

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by