معرفی
این قسمت از کتابخانه طراحی شده است تا بتوانید حساب خود را مدیریت کنید.
$app->Account->{...};
getMySelf
/**
* get Session Data
*
* @return array user data of session
*/
public function getMySelf(): array
نمونه داده های بازگردانده شده:
{
"user_guid": "u0H...",
"first_name": "Amir",
"phone": "98921...",
"username": "",
"last_online": 1723291788,
"is_deleted": false,
"is_verified": false,
"online_time": {
"type": "Exact",
"exact_time": 1723291788
}
}
logout
/**
* Terminate This Session
*
* @return array API result
*/
public function logout(): array
getMySessions
/**
* get Account Sessions List
*
* @return array API result
*/
public function getMySessions(): array
نمونه خروجی: کلیک کنید
TerminateSession
/**
* Set Account Username
*
* @param string $newUserName example: @rubika_lib or rubika_lib
* @return array API result
*/
public function TerminateSession(string $session_key): array
نکته!
برای استفاده از این متد حتما باید حداقل یک هفته از ورود به حساب گذشته باشد. کند.
ChangeUsername
/**
* Set Account Username
*
* @param string $newUserName example: @rubika_lib or rubika_lib
* @return bool username can be set on profile
*/
public function ChangeUsername(string $newUserName): array
لیست توضیحات پارامتر هارا نیز میبینید:
| پارامتر | توضیحات |
| $newUserName |
نام کاربری جدیدی که آزاد باشد. میتوانید با متد CheckUsername انرا متوجه شوید. |
CheckUsername
/**
* checks that an username can be used or not
*
* @param string $username example: @rubika_lib or rubika_lib
* @return bool username can be set on profile
*/
public function CheckUsername(string $username): bool
لیست توضیحات پارامتر هارا نیز میبینید:
| پارامتر | توضیحات |
| $username | بررسی میکند که ایا یک نام کاربری آزاد است یا خیر. |
EditProfile
/**
* Edit Account Info
*
* @param string $first_name new first name (if want to change)
* @param string $last_name new last name (if want to change)
* @param string $bio new bio (if want to change)
* @throws Failure on error
* @return array API result
*/
public function EditProfile(
string $first_name = '',
string $last_name = '',
string $bio = ''
): array
برای این متد حداقل باید یکی از پارامتر هارا پاس دهید در غیر این صورت یک Failure دریافت میکنید. لیست توضیحات پارامتر هارا نیز میبینید:
| پارامتر | توضیحات |
| $first_name | نام حساب |
| $last_name | نام خانوادگی حساب |
| $bio | بیوگرافی حساب |
RequestDeleteAccount
/**
* Request Delete Account
*
* @return array API result
*/
public function RequestDeleteAccount(): array
این متد درخواست حذف حساب کاربری را به روبیکا ارسال میکند و صاحت حساب با دریافت لین پیامک حای لینک صفحه حذف حساب میتوانید آنرا برای همیشه حذف کند.
turnOffTwoStep
/**
* turn off account passwrod
*
* @return array API result
*/
public function turnOffTwoStep(): array
UploadNewProfileAvatar
/**
* Upload New Profile Picture
*
* @param string $file_path must be a picture (png/jpg/jpeg)
* @param bool $isLink
* @return array API result
*/
public function UploadNewProfileAvatar(
string $file_path,
bool $isLink = false
): array
این تصویری که انتخاب میکنید به عنوان اخرین تصویر پروفایل به لیست پروفایلتان افزوده خواهد شد.
| پارامتر | توضیحات |
| $file_path | آدرس فایل تصویر |
| $isLink | آیا $file_path یک لینک است؟ |
DeleteMyAvatar
/**
* Delete Profile Picture
*
* @param string $avatar_id
* @return void API result
*/
public function DeleteMyAvatar(string $avatar_id): bool
لیست توضیحات پارامتر هارا نیز میبینید:
| پارامتر | توضیحات |
| $avatar_id | شناسه تصویری که میخاهید انرا حذف کنید. |