Files
discoursejs/docs/sdk/models/operations/user.md

37 KiB
Raw Blame History

User

Example Usage

import { User } from "@lukehagar/discoursejs/sdk/models/operations";

let value: User = {
    admin: false,
    allowedPmUsernames: ["<value>"],
    avatarTemplate: "<value>",
    badgeCount: 214880,
    canBeDeleted: false,
    canChangeBio: false,
    canChangeLocation: false,
    canChangeTrackingPreferences: false,
    canChangeWebsite: false,
    canDeleteAllPosts: false,
    canEdit: false,
    canEditEmail: false,
    canEditName: false,
    canEditUsername: false,
    canIgnoreUser: false,
    canMuteUser: false,
    canSendPrivateMessageToUser: false,
    canSendPrivateMessages: false,
    canUploadProfileHeader: false,
    canUploadUserCardBackground: false,
    createdAt: "<value>",
    customFields: {},
    featuredTopic: "<value>",
    featuredUserBadgeIds: ["<value>"],
    flairBgColor: "<value>",
    flairColor: "<value>",
    flairGroupId: "<value>",
    flairName: "<value>",
    flairUrl: "<value>",
    groupUsers: [
        {
            groupId: 277628,
            notificationLevel: 186458,
            userId: 586784,
        },
    ],
    groups: [
        {
            allowMembershipRequests: false,
            automatic: false,
            bioCooked: "<value>",
            bioExcerpt: "<value>",
            bioRaw: "<value>",
            canAdminGroup: false,
            canSeeMembers: false,
            defaultNotificationLevel: 807581,
            displayName: "Salvador67",
            flairBgColor: "<value>",
            flairColor: "<value>",
            flairUrl: "<value>",
            fullName: "Randall Cole",
            grantTrustLevel: "<value>",
            hasMessages: false,
            id: 704474,
            incomingEmail: "<value>",
            membersVisibilityLevel: 396060,
            membershipRequestTemplate: "<value>",
            mentionableLevel: 463150,
            messageableLevel: 565421,
            name: "<value>",
            primaryGroup: false,
            publicAdmission: false,
            publicExit: false,
            publishReadState: false,
            title: "<value>",
            userCount: 840429,
            visibilityLevel: 183280,
        },
    ],
    hasTitleBadges: false,
    id: 204865,
    ignored: false,
    ignoredUsernames: ["<value>"],
    invitedBy: "<value>",
    lastPostedAt: "<value>",
    lastSeenAt: "<value>",
    locale: "en",
    mailingListPostsPerDay: 164959,
    moderator: false,
    muted: false,
    mutedCategoryIds: ["<value>"],
    mutedTags: ["<value>"],
    mutedUsernames: ["<value>"],
    name: "<value>",
    pendingCount: 488056,
    postCount: 124833,
    primaryGroupId: "<value>",
    primaryGroupName: "<value>",
    profileViewCount: 355613,
    recentTimeRead: 722081,
    regularCategoryIds: ["<value>"],
    secondFactorEnabled: false,
    staged: false,
    systemAvatarTemplate: "<value>",
    systemAvatarUploadId: "<value>",
    timeRead: 940432,
    title: "<value>",
    trackedCategoryIds: ["<value>"],
    trackedTags: ["<value>"],
    trustLevel: 30452,
    uploadedAvatarId: "<value>",
    useLogoSmallAsAvatar: false,
    userApiKeys: "<value>",
    userAuthTokens: [
        {
            browser: "<value>",
            clientIp: "<value>",
            createdAt: "<value>",
            device: "<value>",
            icon: "<value>",
            id: 765326,
            isActive: false,
            location: "<value>",
            os: "<value>",
            seenAt: "<value>",
        },
    ],
    userNotificationSchedule: {
        day0EndTime: 746994,
        day0StartTime: 748664,
        day1EndTime: 92596,
        day1StartTime: 903720,
        day2EndTime: 217450,
        day2StartTime: 83422,
        day3EndTime: 749255,
        day3StartTime: 552193,
        day4EndTime: 731694,
        day4StartTime: 584476,
        day5EndTime: 45614,
        day5StartTime: 961937,
        day6EndTime: 209157,
        day6StartTime: 292147,
        enabled: false,
    },
    userOption: {
        allowPrivateMessages: false,
        autoTrackTopicsAfterMsecs: 286915,
        automaticallyUnpinTopics: false,
        colorSchemeId: "<value>",
        darkSchemeId: "<value>",
        digestAfterMinutes: 240829,
        dynamicFavicon: false,
        emailDigests: false,
        emailInReplyTo: false,
        emailLevel: 677263,
        emailMessagesLevel: 100294,
        emailPreviousReplies: 63038,
        enableAllowedPmUsers: false,
        enableDefer: false,
        enableQuoting: false,
        externalLinksInNewTab: false,
        hideProfileAndPresence: false,
        homepageId: "<value>",
        includeTl0InDigests: false,
        likeNotificationFrequency: 16429,
        mailingListMode: false,
        mailingListModeFrequency: 555649,
        newTopicDurationMinutes: 929530,
        notificationLevelWhenReplying: 9240,
        skipNewUserTips: false,
        textSize: "<value>",
        textSizeSeq: 669917,
        themeIds: ["<value>"],
        themeKeySeq: 833038,
        timezone: "Asia/Kuala_Lumpur",
        titleCountMode: "<value>",
        userId: 984330,
    },
    username: "Earline.Prosacco",
    watchedCategoryIds: ["<value>"],
    watchedFirstPostCategoryIds: ["<value>"],
    watchedTags: ["<value>"],
    watchingFirstPostTags: ["<value>"],
};

Fields

Field Type Required Description
admin boolean ✔️ N/A
allowedPmUsernames any[] ✔️ N/A
avatarTemplate string ✔️ N/A
badgeCount number ✔️ N/A
canBeDeleted boolean ✔️ N/A
canChangeBio boolean ✔️ N/A
canChangeLocation boolean ✔️ N/A
canChangeTrackingPreferences boolean ✔️ N/A
canChangeWebsite boolean ✔️ N/A
canDeleteAllPosts boolean ✔️ N/A
canEdit boolean ✔️ N/A
canEditEmail boolean ✔️ N/A
canEditName boolean ✔️ N/A
canEditUsername boolean ✔️ N/A
canIgnoreUser boolean ✔️ N/A
canMuteUser boolean ✔️ N/A
canSendPrivateMessageToUser boolean ✔️ N/A
canSendPrivateMessages boolean ✔️ N/A
canUploadProfileHeader boolean ✔️ N/A
canUploadUserCardBackground boolean ✔️ N/A
createdAt string ✔️ N/A
customFields operations.GetUserCustomFields ✔️ N/A
displaySidebarTags boolean N/A
featuredTopic string ✔️ N/A
featuredUserBadgeIds any[] ✔️ N/A
flairBgColor string ✔️ N/A
flairColor string ✔️ N/A
flairGroupId string ✔️ N/A
flairName string ✔️ N/A
flairUrl string ✔️ N/A
groupUsers operations.GroupUsers[] ✔️ N/A
groups operations.GetUserGroups[] ✔️ N/A
hasTitleBadges boolean ✔️ N/A
id number ✔️ N/A
ignored boolean ✔️ N/A
ignoredUsernames any[] ✔️ N/A
invitedBy string ✔️ N/A
lastPostedAt string ✔️ N/A
lastSeenAt string ✔️ N/A
locale string ✔️ N/A
mailingListPostsPerDay number ✔️ N/A
moderator boolean ✔️ N/A
muted boolean ✔️ N/A
mutedCategoryIds any[] ✔️ N/A
mutedTags any[] ✔️ N/A
mutedUsernames any[] ✔️ N/A
name string ✔️ N/A
pendingCount number ✔️ N/A
pendingPostsCount number N/A
postCount number ✔️ N/A
primaryGroupId string ✔️ N/A
primaryGroupName string ✔️ N/A
profileViewCount number ✔️ N/A
recentTimeRead number ✔️ N/A
regularCategoryIds any[] ✔️ N/A
secondFactorBackupEnabled boolean N/A
secondFactorEnabled boolean ✔️ N/A
sidebarCategoryIds any[] N/A
sidebarTags any[] N/A
staged boolean ✔️ N/A
systemAvatarTemplate string ✔️ N/A
systemAvatarUploadId string ✔️ N/A
timeRead number ✔️ N/A
title string ✔️ N/A
trackedCategoryIds any[] ✔️ N/A
trackedTags any[] ✔️ N/A
trustLevel number ✔️ N/A
uploadedAvatarId string ✔️ N/A
useLogoSmallAsAvatar boolean ✔️ N/A
userApiKeys string ✔️ N/A
userAuthTokens operations.UserAuthTokens[] ✔️ N/A
userFields operations.UserFields N/A
userNotificationSchedule operations.UserNotificationSchedule ✔️ N/A
userOption operations.UserOption ✔️ N/A
username string ✔️ N/A
watchedCategoryIds any[] ✔️ N/A
watchedFirstPostCategoryIds any[] ✔️ N/A
watchedTags any[] ✔️ N/A
watchingFirstPostTags any[] ✔️ N/A