PHP Класс seregazhuk\PinterestBot\Api\Providers\User

Наследование: extends Provider, use trait seregazhuk\PinterestBot\Api\Traits\UploadsImages
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$loginRequiredFor array

Открытые методы

Метод Описание
convertToBusiness ( string $businessName, string $websiteUrl = '' ) : boolean Convert your account to a business one.
deactivate ( string $reason = 'other', string $explanation = '' ) : boolean Deactivates your account.
invite ( string $email ) : boolean | Response Send invite to email
isBanned ( ) : boolean Checks if current user is banned
profile ( array $userInfo = [] ) : boolean | array Updates or returns user profile info. Gets associative array as a param. Available keys of array are: 'last_name', 'first_name', 'username', 'about', 'location' and 'website_url'.
username ( ) : string Returns current user username

Описание методов

convertToBusiness() публичный Метод

Convert your account to a business one.
public convertToBusiness ( string $businessName, string $websiteUrl = '' ) : boolean
$businessName string
$websiteUrl string
Результат boolean

deactivate() публичный Метод

Deactivates your account.
public deactivate ( string $reason = 'other', string $explanation = '' ) : boolean
$reason string
$explanation string
Результат boolean

invite() публичный Метод

Send invite to email
public invite ( string $email ) : boolean | Response
$email string
Результат boolean | seregazhuk\PinterestBot\Api\Response

isBanned() публичный Метод

Checks if current user is banned
public isBanned ( ) : boolean
Результат boolean

profile() публичный Метод

You can also change user avatar by passing 'profile_image'.
public profile ( array $userInfo = [] ) : boolean | array
$userInfo array If empty returns current user profile.
Результат boolean | array

username() публичный Метод

Returns current user username
public username ( ) : string
Результат string

Описание свойств

$loginRequiredFor защищенное свойство

protected array $loginRequiredFor
Результат array