User Command Word

createUser

\FresnsCmdWord::plugin('Fresns')->createUser($wordBody);

Parameter Name	Type	Required	Description
aid	String	required	Related field accounts->aid
aidToken	String	optional	If not passed, the account identity will not be verified, and users will be added directly to the account
appId	String	optional	App ID, required when passing aidToken
platformId	Number	optional	Platform ID, required when passing aidToken
version	String	optional	Semantic version number, required when passing aidToken
username	String	optional	Username, related field users->username If not passed, a random 6-8 character string will be generated, avoiding the use of banned names (key name user_ban_names banned values)
nickname	String	optional	Nickname, related field users->nickname If not passed, a random 8 character string
pin	String	optional	Login pin, related field users->pin
avatarFid	String	optional	Avatar file fid, converted to files->id when stored Related field users->avatar_file_id
avatarUrl	String	optional	Avatar file URL, related field users->avatar_file_url
bannerFid	String	optional	Banner file fid, converted to files->id when stored Related field users->banner_file_id
bannerUrl	String	optional	Banner file URL, related field users->banner_file_url
gender	Number	optional	Gender, related field users->gender
genderPronoun	Number	optional	Gender Pronoun, related field users->gender_pronoun
genderCustom	String	optional	Gender Custom, related field users->gender_custom

Return Example

{
    "code": 0,
    "message": "ok",
    "data": {
        "aid": "accounts->aid",
        "aidToken": "aidToken",
        "uid": "users->uid",
        "username": "users->username",
        "nickname": "users->nickname"
    }
}

View the add logic

• Data list to be generated during registration
  • Main user table users
  • User data statistics table user_stats
  • User role association table user_roles: The initial role comes from the default_role key in the configuration table.
  • For other parameters, if there's a value, record it directly; if not, leave it blank.

verifyUser

\FresnsCmdWord::plugin('Fresns')->verifyUser($wordBody);

Parameter Name	Type	Required	Description
appId	String	required	App ID
platformId	Number	required	Platform ID (key value of the key name in the configuration table platforms)
version	String	required	Semantic version number
aid	String	required	Account AID accounts->aid
aidToken	String	required	Account Token
uid	Number	required	User UID users->uid
pin	String	optional	Personal Identification Number users->pin

Return Example

{
    "code": 0,
    "message": "ok",
    "data": {
        "aid": "accounts->aid",
        "aidToken": "aidToken",
        "uid": "users->uid",
    }
}

createUserToken

\FresnsCmdWord::plugin('Fresns')->createUserToken($wordBody);

Parameter Name	Type	Required	Description
appId	String	required	App ID
platformId	Number	required	Platform ID (key value of the key name in the configuration table platforms)
version	String	required	Semantic version number
aid	String	required	Account parameter session_tokens->account_id Stored as accounts->id when converted from aid
aidToken	String	required	Account identity credential (credential table session_tokens->token field)
uid	Number	required	User parameter session_tokens->user_id Stored as users->id when converted from uid
deviceToken	String	optional	Interaction device Token For example, iOS Device Token or Android Device Token Can be used for push notifications
expiredTime	Number	optional	Expiration time, unit: hours (empty means valid forever)

Return Example

{
    "code": 0,
    "message": "ok",
    "data": {
        "aid": "aid",
        "aidToken": "aidToken",
        "uid": "users->uid",
        "uidToken": "session_tokens->token",
        "uidTokenId": "session_tokens->id",
        "expiredHours": "Expiration hours", // If not available, output null
        "expiredDays": "Expiration days", // If not available, output null
        "expiredDateTime": "session_tokens->expired_at, leave empty for permanent validity, format: Y-m-d H:i:s", // If not available, output null
    }
}

verifyUserToken

\FresnsCmdWord::plugin('Fresns')->verifyUserToken($wordBody);

Parameter Name	Type	Required	Description
platformId	Number	required	Platform ID (key value of the key name in the configuration table platforms)
aid	String	required	Account parameter session_tokens->account_id Checked by converting aid to accounts->id
aidToken	String	required	Account identity credential (credential table session_tokens->token field)
uid	Number	required	User parameter session_tokens->user_id Checked by converting uid to users->id
uidToken	String	required	User identity credential (credential table session_tokens->token field)

getUserDeviceToken

\FresnsCmdWord::plugin('Fresns')->getUserDeviceToken($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required
platformId	Number	optional	Platform ID (Key value of the platforms key name in the configuration table) No value then output all

• The result is an array sorted in reverse chronological order by creation time, with the most recent creation on top.

Return Example

{
    "code": 0,
    "message": "ok",
    "data": [
        {
            "platformId": 5,
            "deviceToken": "",
            "datetime": ""
        }
    ]
}

logicalDeletionUser

\FresnsCmdWord::plugin('Fresns')->logicalDeletionUser($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid

physicalDeletionUser

\FresnsCmdWord::plugin('Fresns')->physicalDeletionUser($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid

• Physical deletion involves a lot of content, so the deletion function is performed using a queue, so configure the Fresns queues.

setUserExtcredits

\FresnsCmdWord::plugin('Fresns')->setUserExtcredits($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid
extcreditsId	Number	required	extcredits id 1-5
fskey	String	required	plugin fskey
operation	String	required	Operation Type increment or decrement
amount	Number	optional	Leave blank to default to 1
remark	String	optional	Remark

setUserExpiryDatetime

\FresnsCmdWord::plugin('Fresns')->setUserExpiryDatetime($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid
datetime	String	optional	Y-m-d H:i:s Date and time value, timezone is the database timezone
clearDatetime	Boolean	optional	Whether to clear the user's validity period

• Choose one between datetime and clearDatetime to pass as a parameter.
• This feature is only effective for site private mode.
• This feature is only effective for group private mode.
• If the user has not joined the group, they will automatically join the group and set the validity period.

setUserGroupExpiryDatetime

\FresnsCmdWord::plugin('Fresns')->setUserGroupExpiryDatetime($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid
gid	String	required	Group GID groups->gid
datetime	String	optional	Y-m-d H:i:s Date and time value, timezone is the database timezone
clearDatetime	Boolean	optional	Whether to clear the user's validity period

• Choose one between datetime and clearDatetime to pass as a parameter.
• This feature is only effective for group private mode.
• If the user has not joined the group, they will automatically join the group and set the validity period.

setUserBadge

\FresnsCmdWord::plugin('Fresns')->setUserBadge($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid
fskey	String	required	plugin fskey
type	Number	required	1. Red dot / 2. Number / 3. Text
badgeNumber	Number	optional	Required for type=2, the displayed number. If an old number exists, it will be accumulated
badgeText	String	optional	Required for type=3, the displayed text content. Supports up to 8 characters

clearUserBadge

\FresnsCmdWord::plugin('Fresns')->clearUserBadge($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid
fskey	String	required	plugin fskey

clearUserAllBadges

\FresnsCmdWord::plugin('Fresns')->clearUserAllBadges($wordBody);

Parameter Name	Type	Required	Description
uid	Number	required	User UID users->uid