Программный продукт «QP8.Framework» (стр. 26 )

Методы для работы с уведомлениями

Метод SendNotification

public void SendNotification(int content_item_id, string notification_on)

Инициирует механизм формирования уведомления для указанной статьи.

Примечание: если для сайта не задан флаг «Собирать страницы для предварительного просмотра и уведомлений в Основном режиме», то на работу метода влияет параметр IsStage (определяет, для какого режима должны собираться уведомления).

Вспомогательные методы

Примечание: если для экземпляра класса включено кэширование, то, если не указано иное, результаты всех методов кэшируются на время, заданное в конфигурационном файле веб-сайта.

Метод FieldID

public int FieldID(int site_id, string content_name, string field_name)

Возвращает идентификатор указанного поля.

Параметры:

Название	Описание
site_id	Идентификатор сайта
content_name	Имя контента. Примечание: поддерживается имя контента в формате SiteName. ContentName.
field_name	Имя поля

Метод FieldName

public string FieldName(int site_id, string content_name, string field_name)

Возвращает внутреннее имя поля.

Примечание: используется при формировании ключей коллекции Values для метода AddFormToContent.

Параметры:

Название	Описание
site_id	Идентификатор сайта
content_name	Имя контента. Примечание: поддерживается имя контента в формате SiteName. ContentName.
field_name	Имя поля

Метод FormatField

public string FormatField(string key, int site_id)
public string FormatField(string key, int site_id, isLive)

Выполняет замену заполнителей на URI. Если параметр isLive не задан, то используется инвертированное значение свойства IsStage.

Замена осуществляется на следующие URI из следующих параметров:

GetImagesUploadUrl, GetSiteUrl или GetSiteUrlRel (в зависимости от значения параметра UseAbsoluteSiteUrl).

Примечание: следует применять метод при чтении данных статей во всех случаях, кроме использования классов LINQ to SQL и метода Field, в которых имеется идентичная функциональная возможность.

Метод GetSiteId

public int GetSiteId(string name)

Выводит идентификатор сайта по указанному имени сайта.

Метод GetSiteIdByContentId

public Int32 GetSiteIdByContentId(int contentId)

Выводит идентификатор сайта по указанному идентификатору контента.

Метод GetSiteName

public string GetSiteName(int site_id)

Выводит имя сайта по указанному идентификатору сайта.

Метод GetContentId

public int GetContentId(int siteId, string contentName)

Выводит идентификатор контента по указанным идентификатору сайта и имени контента.

Примечание: поддерживается имя контента в формате SiteName. ContentName.

Метод GetContentIdForAttribute

public int GetContentIdForAttribute(int id)

Выводит идентификатор контента по указанному идентификатору поля.

Метод GetContentIdForItem

public int GetContentIdForItem(int ItemID)

Выводит идентификатор контента по указанному идентификатору статьи.

Метод GetContentName

public string GetContentName(int contentId)

Выводит имя контента по указанному идентификатору контента.

Метод GetContentFieldValue

public string GetContentFieldValue(int itemID, string fieldName)

Выводит значение поля в виде строки.

Параметры:

Название	Описание
itemID	Идентификатор статьи
fieldName	Имя поля

В качестве результата возвращается пустая строка, если:

статья не существует, поле не существует, поле содержит значение NULL.

Примечание: на результат влияет значение свойства IsStage. При IsStage = true возвращаются данные текущей статьи, иначе – данные опубликованной.

Внешние транзакции

Поддерживается возможность выполнить несколько операций в БД (например, несколько различных вызовов метода MassUpdate для разных контентов) в рамках единой транзакции.

Для этого следует:

создать SQL-соединение с БД; открыть созданное соединение; начать транзакцию на открытом соединении; создать экземпляр DBConnector;

Экземпляру в качестве параметров должны быть переданы данные по:

открытому соединению, транзакции. выполнить необходимые операции на созданном соединении.

Пример:

using (var conn = new SqlConnection(Global. ConnectionString))

{

conn. Open();

var tr = conn. BeginTransaction();

var localCnn = new DBConnector(conn, tr);

try

{

localCnn. MassUpdate(BaseContentId, values, Global. LastModifiedId);

localCnn. MassUpdate(ContentId, values2, Global. LastModifiedId);

mit();

}

catch (Exception)

{

tr. Rollback();

}

}

Класс QScreen

Метод CheckCustomTabAuthentication

public static bool CheckCustomTabAuthentication()

Используется для аутентификации при использовании пользовательских действий. В случае успешной аутентификации возвращает true.

Следует использовать для аутентификации при каждой перезагрузке страницы для пользовательского действия.

Внимание: на веб-сайте должны быть включены сессии. Если это требование невыполнимо, то следует использовать метод AuthenticateForCustomTab.

Метод AuthenticateForCustomTab

public static int AuthenticateForCustomTab()

Используется для аутентификации при использовании пользовательских действий. В случае успешной аутентификации возвращает идентификатор пользователя, иначе – 0.

Следует использовать при первом вызове пользовательского действия. При перезагрузках страниц пользовательского действия метод использовать нельзя, так как аутентификация возможна только при первом вызове, поэтому результат аутентификации нужно сохранять. Если есть возможность хранить его в сессии, то следует использовать метод CheckCustomTabAuthentication.

Класс Permissions

Класс предоставляет возможности управления:

пользователями, группами пользователей, правами доступа.

Метод AddChildGroupToParentGroup

public void AddChildGroupToParentGroup(int parent_group_id, int child_group_id)

Задаёт для группы c идентификатором child_group_id родительскую группу с идентификатором parent_group_id.

Метод AddGroup

public int AddGroup(string name)
public int AddGroup(string name, bool AllowSharedOwnershipOfItem)

Создаёт новую группу. Результат содержит идентификатор группы.

Параметры:

Название	Описание
name	Имя для новой группы
AllowSharedOwnershipOfItem	Указатель, что допускается использование опции «Совместное использование статей» в свойствах группы. Значение по умолчанию – false.

Метод AddGroupToContentPermission

public void AddGroupToContentPermission(int groupId, int contentId, int permissionId)
public void AddGroupToContentPermission(int groupId, int contentId, int permissionId, bool propagateToItems)

Задаёт или изменяет права доступа для группы на указанный контент.

Параметры:

Название	Описание
groupId	Идентификатор группы
contentId	Идентификатор контента
permissionId	Права доступа
propagateToItems	Указатель, что права доступа должны будут применяться к новым статьям, создаваемым в контенте

Метод AddGroupToItemPermission

public void AddGroupToItemPermission(int groupId, int itemId, int permissionId)

Задаёт или изменяет права доступа для группы на указанную статью.

Параметры:

Название	Описание
groupId	Идентификатор группы
itemId	Идентификатор статьи
permissionId	Права доступа

Метод AddUser

public int AddUser(string username, string password, string First_Name, string Last_Name, string Email)

Создаёт нового пользователя. Результат содержит идентификатор пользователя.

Примечание: пользователь, создаваемый таким образом, по умолчанию не имеет доступа в бекэнд (активно свойство «Заблокирован» (Disabled)).

Параметры:

Название	Описание
username	Имя пользователя
password	Пароль пользователя
First_Name	Имя персоны, для которой создаётся пользователь
Last_Name	Фамилия персоны, для которой создаётся пользователь
Email	Адрес электронной почты персоны, для которой создаётся пользователь

Метод AddUserToContentPermission

public void AddUserToContentPermission(int userId, int contentId, int permissionId)
public void AddUserToContentPermission(int userId, int contentId, int permissionId, bool propagateToItems)

Задаёт или изменяет права доступа для пользователя на указанный контент.

Параметры:

Название	Описание
userId	Идентификатор группы
contentId	Идентификатор контента
permissionId	Права доступа
propagateToItems	Указатель, что права доступа должны будут применяться к новым статьям, создаваемым в контенте

Метод AddUserToGroup

public void AddUserToGroup(int userId, int groupId)