helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Specific.XML

<?xml version="1.0" encoding="utf-8"?>
<doc>
    <assembly>
        <name>ASC.Specific</name>
    </assembly>
    <members>
        <member name="T:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint">
            <summary>Авторизация для API</summary>
        </member>
        <member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String,System.String)">
            <summary>Получает токен аутентификации для использования при авторизации API</summary>
            <short>Получить токен</short>
            <param name="userName">имя пользователя или адрес эл. почты</param>
            <param name="password">пароль</param>
            <param name="provider">тип поставщика услуг социальных сетей</param>
            <param name="accessToken">токен поставщика</param>
            <returns>токен, применяемый в заголовке &quot;Авторизация&quot; при вызове методов API</returns>
            <exception cref="T:System.Security.Authentication.AuthenticationException">Появляется при отсутствии аутентификации</exception>
        </member>
        <member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.SaveMobilePhone(System.String,System.String,System.String,System.String,System.String)">
            <summary>Задать мобильный телефон для пользователя</summary>
            <param name="userName">имя пользователя или адрес эл. почты</param>
            <param name="password">пароль</param>
            <param name="provider">тип поставщика услуг социальных сетей</param>
            <param name="accessToken">токен поставщика</param>
            <param name="mobilePhone">новый мобильный телефон</param>
            <returns>мобильный телефон</returns>
        </member>
        <member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.SendSmsCode(System.String,System.String,System.String,System.String)">
            <summary>Снова отправить код по СМС</summary>
            <param name="userName">имя пользователя или адрес эл. почты</param>
            <param name="password">Пароль</param>
            <param name="provider">тип поставщика услуг социальных сетей</param>
            <param name="accessToken">токен поставщика</param>
            <returns>мобильный телефон</returns>
        </member>
        <member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String,System.String,System.String)">
            <summary>Получить токен двухфакторной аутентификации для использования при авторизации API</summary>
            <short>Получить токен</short>
            <param name="userName">имя пользователя или адрес эл. почты</param>
            <param name="password">пароль</param>
            <param name="provider">тип поставщика услуг социальных сетей</param>
            <param name="accessToken">токен поставщика</param>
            <param name="code">код из СМС</param>
            <returns>токен, применяемый в заголовке &quot;Авторизация&quot; при вызове методов API</returns>
        </member>
        <member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.RegisterUserOnPersonal(System.String,System.String,System.Boolean,System.Boolean)">
            <summary>Запрос по электронной почте приглашения посетить personal.onlyoffice.com</summary>
            <param name="email">Адрес эл. почты</param>
            <param name="lang">Культура</param>
            <param name="spam">Согласие пользователя подписаться на рассылку новостей</param>
            <param name="analytics">Отслеживать аналитику</param>
            <visible>false</visible>
        </member>
        <member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String)">
            <summary>Проверить имя пользователя и пароль</summary>
            <param name="userName">имя пользователя или адрес эл. почты</param>
            <param name="password">Пароль</param>
            <param name="key"></param>
            <exception cref="T:System.Security.Authentication.AuthenticationException">Появляется при отсутствии аутентификации</exception>
            <visible>false</visible>
        </member>
        <member name="P:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.Name">
            <summary>Название точки входа</summary>
        </member>
        <member name="T:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint">
            <summary>Возможности для API</summary>
        </member>
        <member name="M:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.#ctor(ASC.Api.Impl.ApiContext)">
            <summary>Constructor</summary>
            <param name="context"></param>
        </member>
        <member name="M:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.GetPortalCapabilities">
            <summary>Возвращает сведения о возможностях портала</summary>
            <short>Получить возможности портала</short>
            <returns>CapabilitiesData</returns>
        </member>
        <member name="P:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.Name">
            <summary>Название точки входа</summary>
        </member>
    </members>
</doc>