Skip to main content

UserStatusArgs

type UserStatusArgs = {
activeUntil?: Date | string | null;
effects?: | {
pauseActivity?: UserStatusEffectArgs | null;
pauseNotifications?: UserStatusEffectArgs | null;
}
| null;
emoji?: string | null;
message?: string;
};

Only supplied fields change. Null removes optional fields and effects.

Properties​

activeUntil?​

optional activeUntil: Date | string | null;

Must be in the future; null removes expiry, omission preserves it. Dates are sent as ISO strings.


effects?​

optional effects:
| {
pauseActivity?: UserStatusEffectArgs | null;
pauseNotifications?: UserStatusEffectArgs | null;
}
| null;

Supplied effects are merged; null clears all effects, omission or {} preserves them.

Type Declaration​

{
pauseActivity?: UserStatusEffectArgs | null;
pauseNotifications?: UserStatusEffectArgs | null;
}
NameTypeDescription
pauseActivity?UserStatusEffectArgs | nullNull removes the effect; {} preserves its configuration or enables it with defaults.
pauseNotifications?UserStatusEffectArgs | nullNull removes the effect; {} preserves its configuration or enables it with defaults.

null


emoji?​

optional emoji: string | null;

message?​

optional message: string;

Required when creating a status; omit to preserve the existing message.