Skip to main content

Interface: SCUserType

Hierarchy​

Indexable​

▪ [p: string]: any

Custom user metadata fields

Properties​

avatar​

• avatar: string

Avatar of the user.

Defined in​

user.ts:121

bio​

• bio: string

User biography.

Defined in​

user.ts:57

can_send_pm_to​

• Optional can_send_pm_to: boolean

If the logged user is able to send a private message to the requested user (visible only in the get a specific user api response).

Defined in​

user.ts:236

categories_counter​

• Optional categories_counter: number

Number of categories followed by the user.

Defined in​

user.ts:206

community_badge​

• Optional community_badge: boolean

If the user has the community badge active.

Defined in​

user.ts:146

connection_requests_received_counter​

• Optional connection_requests_received_counter: number

Number of connection requests received by the user.

Defined in​

user.ts:166

connection_requests_sent_counter​

• Optional connection_requests_sent_counter: number

Number of connection requests sent by the user.

Defined in​

user.ts:161

connection_status​

• Optional connection_status: string

The connection status between the request user and this user.

Defined in​

user.ts:156

connections_counter​

• Optional connections_counter: number

Number of connections of the user.

Defined in​

user.ts:171

cover​

• Optional cover: string

Image Cover of the user.

Defined in​

user.ts:126

date_joined​

• date_joined: Date

Date joined to the community.

Defined in​

user.ts:52

date_of_birth​

• Optional date_of_birth: Date

Date of birth. Format: YYYY-MM-DD (ISO 8601).

Defined in​

user.ts:77

deleted​

• Optional deleted: boolean

If the user account has been deleted

Defined in​

user.ts:226

deleted_at​

• Optional deleted_at: Date

Datetime of the account deletion

Defined in​

user.ts:231

description​

• description: string

User description.

Defined in​

user.ts:82

discussions_counter​

• Optional discussions_counter: number

Number of discussions created by the user.

Defined in​

user.ts:191

email​

• Optional email: string

Email of the user.

Defined in​

user.ts:37

email_isvalid​

• Optional email_isvalid: boolean

Email is valid. Default: False.

Defined in​

user.ts:42

ext_id​

• Optional ext_id: number

The external ID of the user. It is assigned only during signup if necessary.

Defined in​

user.ts:131

followers_counter​

• Optional followers_counter: number

Number of followers of the user

Defined in​

user.ts:181

followings_counter​

• Optional followings_counter: number

Number of followings of the user

Defined in​

user.ts:176

gender​

• gender: string

Gender of the user. Values: Male, Female, Unspecified. Default: Unspecified.

Defined in​

user.ts:87

id​

• id: number

The ID of the user.

Defined in​

user.ts:22

language​

• Optional language: SCLanguageType

User language

Defined in​

user.ts:92

location​

• location: string

Location

Defined in​

user.ts:62

location_lat_lng​

• Optional location_lat_lng: string

Location in coordinates. Format: lat,lng.

Defined in​

user.ts:67

permission​

• Optional permission: string[]

List of user permission. Only for the resource /user/me/.

Defined in​

user.ts:151

polls_counter​

• Optional polls_counter: number

Number of polls created by the user.

Defined in​

user.ts:201

position_lat_lng​

• Optional position_lat_lng: string

User current position. Format: lat,lng.

Defined in​

user.ts:72

posts_counter​

• Optional posts_counter: number

Number of posts created by the user.

Defined in​

user.ts:186

real_name​

• real_name: string

Real name of the user.

Defined in​

user.ts:32

reg_approved​

• Optional reg_approved: boolean

The user is approved and can access the community

Defined in​

user.ts:47

reputation​

• reputation: number

User reputation.

Defined in​

user.ts:141

role​

• Optional role: string

User role

Defined in​

user.ts:211

status​

• Optional status: string

User status. Values: a (approved), b (blocked), d (deleted; soft deleted), u (unregistered). Default: a. A blocked user can't:

  • create contribution (post/discussion/status)
  • create comment
  • vote/unvote contribution
  • follow/connect user
  • edit contribution
  • suggest an incubator
  • flag a contribution
  • send a private message
  • edit info profile but he can't:
  • follow/unfollow a post/discussion/status
  • follow/unfollow a category
  • unfollow user

Defined in​

user.ts:111

statuses_counter​

• Optional statuses_counter: number

Number of statuses created by the user.

Defined in​

user.ts:196

tags​

• tags: SCTagType[]

User's tag list. List of Tag.

Defined in​

user.ts:136

unseen_interactions_counter​

• Optional unseen_interactions_counter: number

interactions counter

Defined in​

user.ts:216

unseen_notification_banners_counter​

• Optional unseen_notification_banners_counter: number

notification banner counter

Defined in​

user.ts:221

username​

• username: string

The username of the user.

Defined in​

user.ts:27

website​

• website: string

User website.

Defined in​

user.ts:116