Table of Contents

Async workflow methods

Listed below are the workflow methods which have been converted into async tasks. Note that this is not a comprehensive list of all workflow methods available, as new methods implemented in MIB 6.0 are not listed here, and were already created as async methods when necessary.

IConfigurationWorkflow

Task<(GenericPermission, string)> GetConfigurablePermissions(CancellationToken cancellationToken)

IContentCriteriaWorkflow

Task<ContentCriteriaViewData> GetViewData(string templateComponentKey, int objectId, string objectType, int contentCriteriaId, string selectionColumnName, List<ResponseItemContent> responseItemContents, IEnumerable<string> asideFields, CancellationToken cancellationToken)

IContextWorkflow

Task<ContextViewData> GetContext(CancellationToken cancellationToken)
Task<ContextViewData> GetContext(IEnumerable<int> ids, CancellationToken cancellationToken)

IFileWorkflow

Task<FileUploadResponse> UploadFile(FileUploadRequest request, CancellationToken cancellationToken)
Task<FileDonwloadResponse> DonwloadFile(string fileName, CancellationToken cancellationToken)

IFormWorkflow

Task<FormViewData> GetUploadItem(string mediaType, CancellationToken cancellationToken)
Task<FormViewData> GetItem(ResponseItemContent itemContent, ResponseItemContent metaContent, int id, List<string> includeFields, List<string> excludeFields, Dictionary<string, string> asideFields, Dictionary<string, string> asideFilters, string templateComponentKey = null, List<string> createOnlyFields = null, CancellationToken cancellationToken = new CancellationToken())
Task<FormViewData> GetBulkItem(IEnumerable<int> ids, string mediaType, List<string> includes, List<string> includeFields, List<string> excludeFields, Dictionary<string, string> asideFields, Dictionary<string, string> asideFilters, List<string> createOnlyFields = null, CancellationToken cancellationToken = new CancellationToken())
Task<FormViewData> GetNewRelatedItem(string mediaType, List<string> includeFields, List<string> excludeFields, Dictionary<string, string> asideFields, Dictionary<string, string> asideFilters, CancellationToken cancellationToken)
Task<List<FormViewData>> GetExistingRelatedItems(IEnumerable<int> ids, string mediaType, List<string> includes, List<string> includeFields, List<string> excludeFields, Dictionary<string, string> asideFields, Dictionary<string, string> asideFilters, Dictionary<string, Uri> redirectToEditPageByField, CancellationToken cancellationToken)
Task<RelatedFormViewData> GetRelateds(ResponseItemContent itemContent, ResponseItemContent metaContent, FormWorkflowRelatedsOptions options, List<ResponseItemContent> relatedsMetaContents, CancellationToken cancellationToken)
Task<List<string>> GetRequiredIncludes(ResponseItemContent metaContent, List<string> excludeFields, string templateComponentKey = null, CancellationToken cancellationToken = new CancellationToken())

IImageWorkflow

Task<string> GetImageUrl(string mediaType, int id, CancellationToken cancellationToken)

IListWorkflow

Task<ListViewData> GetList(SearchCriteria criteria, PermissionSetContainer permissionSet = null, CancellationToken cancellationToken = new CancellationToken())
Task<ListViewData> GetRelatedView(SearchCriteria searchCriteria, string pageKey, string templateComponentKey, bool isMultiSelect, ContentSelectionRequestInformation contentSelection, PermissionSetContainer permissionSet = null, CancellationToken cancellationToken = new CancellationToken())
Task<ContentCriteriaPreviewListViewData> GetList(ContentSelectionRequestInformation contentSelection, Condition filterCondition = null, int contentSelectionId = 0, Guid globalContentSelectionByPublicId = default(Guid), CancellationToken cancellationToken = new CancellationToken())
Task<ListViewData> GetRelateds(string parentMediaType, int id, string mediaType, int copiedFrom, CancellationToken cancellationToken)
Task<List<ItemViewData>> GetRelatedItems(string ids, string mediaType, CancellationToken cancellationToken)
Task<AdvancedSearchViewData> GetAdvancedSearch(string mediaType, CancellationToken cancellationToken)
Task<PreviewViewData> GetItemPreview(int id, string mediaType, CancellationToken cancellationToken)
Task<Dictionary<int, List<int>>> GetRelatedIds(string parentMediaType, List<int> ids, string mediaType, CancellationToken cancellationToken)
Task<ListViewData> GetList(ResponseItemContent itemContent, ResponseItemContent metaContent, List<ResponseItemContent> relatedsMetaContents, SearchCriteria criteria, string templateComponentKey = null, CancellationToken cancellationToken = new CancellationToken())
Task<ListViewData> GetRelateds(ResponseItemContent itemContent, ResponseItemContent metaContent, ResponseItemContent parentContent, string mediaType, string parentMediaType, int parentId, int copiedFrom, bool ignoreRelateds, string templateComponentKey = null, CancellationToken cancellationToken = new CancellationToken())
Task<ListRelatedRequirements> GetRequirements(ResponseItemContent metaContent, SearchCriteria criteria, string parentMediaType = null, string templateComponentKey = null, CancellationToken cancellationToken = new CancellationToken())

IMenuWorkflow

Task<MenuViewData> GetMenu(CancellationToken cancellationToken)
Task<string> GetMenuItemKey(CancellationToken cancellationToken)
Task<string> GetMenuItemKey(string url, CancellationToken cancellationToken)
Task<IEnumerable<MenuItemViewData>> GetBreadcrumb(CancellationToken cancellationToken)
Task<IEnumerable<MenuItemViewData>> GetBreadcrumb(string url, CancellationToken cancellationToken)

IMetaWorkflow

Task<MediaTypeInformation> GetMediaTypeMeta(string name, string parentMediaTypeName = null, CancellationToken cancellationToken = new CancellationToken())
Task<MediaTypeInformation> GetMediaTypeMeta(int mibIndex, string parentMediaTypeMibIndex = null, CancellationToken cancellationToken = new CancellationToken())
Task<MediaTypeInformation> GetMediaTypeMeta(ResponseItemContent content, string parentMediaType = null, List<ResponseItemContent> relatedsMetaContents = null, string templateComponentKey = null, CancellationToken cancellationToken = new CancellationToken())

INotificationWorkflow

Task<NotificationViewData> GetNewNotifications(CancellationToken cancellationToken)
Task<NotificationViewData> GetNotifications(CancellationToken cancellationToken)
Task<NotificationViewData> GetPreviousNotifications(IEnumerable<int> activeNotifications, CancellationToken cancellationToken)
Task MarkAsRead(IEnumerable<int> notificationId, CancellationToken cancellationToken)
Task<string> GetNotificationUrlWithToken(int notificationId, CancellationToken cancellationToken)

IPageStateWorkflow

Task<IEnumerable<IStateManager>> GetState(string pageKey, CancellationToken cancellationToken)
Task SetState(string pageKey, IEnumerable<IStateManager> pageState, CancellationToken cancellationToken)

IPreferenceWorkflow

Task<IEnumerable<PreferenceInformation>> GetPreferences(CancellationToken cancellationToken)
Task<IEnumerable<PreferenceInformation>> GetPreferences(IEnumerable<string> keys, CancellationToken cancellationToken)
Task<IEnumerable<PreferenceInformation>> GetGlobal(IEnumerable<string> keys, CancellationToken cancellationToken)
Task SavePreferences(IEnumerable<PreferenceInformation> preferences, CancellationToken cancellationToken)
Task AppendValueToPreferences(IEnumerable<PreferenceInformation> preferences, CancellationToken cancellationToken)
Task RemoveValueFromPreferences(IEnumerable<PreferenceInformation> preferences, CancellationToken cancellationToken)
Task DeletePreferences(IEnumerable<string> keys, CancellationToken cancellationToken)

IPublicNotificationWorkflow

Task Send(string senderName, string message, string url, IEnumerable<int> userIds, string imageUrl = "", CancellationToken cancellationToken = new CancellationToken())
Task Send(NotificationRequest notification, CancellationToken cancellationToken)

ISearchHistoryWorkflow

Task CreateSearch(SearchCriteria criteria, int userId, string pageKey, string templateComponentKey, CancellationToken cancellationToken)
Task UpdateFavoriteSearch(int id, SearchCriteria criteria, CancellationToken cancellationToken)
Task DeleteAdvancedSearch(int id, CancellationToken cancellationToken);
Task ChangeToFavorite(int historyId, string name, CancellationToken cancellationToken)
Task<IEnumerable<SearchHistoryItem>> GetAllSharedSearchs(int userId, string pageKey, string templateComponentKey, CancellationToken cancellationToken);
Task<SearchHistoryItem> GetSharedSearch(Guid guid, CancellationToken cancellationToken)
Task UnshareSearch(int userId, Guid historyId, CancellationToken cancellationToken)
Task<Guid> ShareSearch(int userId, int historyId, CancellationToken cancellationToken)
Task<List<SearchHistoryItem>> GetHistory(string pageKey, string templateComponentKey, int total, CancellationToken cancellationToken)
Task<List<SearchHistoryItem>> GetFavorites(string pageKey, string templateComponentKey, CancellationToken cancellationToken)
Task<SearchHistoryItem> GetFavorite(string pageKey, string templateComponentKey, int favoriteId, CancellationToken cancellationToken)

ITemplateWorkflow

Task<TemplateInformation> GetTemplate(string templateKey, CancellationToken cancellationToken)
Task<PageInformation> GetPage(string templateConfigurationKey, CancellationToken cancellationToken)
Task<IEnumerable<ComponentInformation>> GetTemplateComponents(TemplateInformation templateInformation, CancellationToken cancellationToken)
Task<ComponentInformation> GetComponent(string componentKey, CancellationToken cancellationToken)
Task<T> GetTemplateComponentConfiguration<T>(string pageKey, string templateComponentKey, CancellationToken cancellationToken)

ITsvExportWorkflow

Task RequestTsvExport(SearchCriteria criteria, int owner, MediaTypeInformation meta, IMetaWorkflow metaWorkflow, string timeZone, string globalFilter, CancellationToken cancellationToken)
Task RequestTsvExport(EditHistorySearchCriteria criteria, int owner, EditHistorySearchCriteriaType criteriaType, CancellationToken cancellationToken)

IUserWorkflow

Task<UserViewData> GetUser(CancellationToken cancellationToken)
Task<IEnumerable<UserViewData>> GetUsers(string nameStartsWith, CancellationToken cancellationToken)
Task<IEnumerable<BooleanPermission>> GetAuthorizationBooleanPermissions(string clientId = null, CancellationToken cancellationToken = new CancellationToken())
Task<IEnumerable<BooleanPermission>> GetAuthorizationBooleanPermissions(int apiClientId, CancellationToken cancellationToken)
Task<Dictionary<int, UserDetailedInformation>> GetUserInformation(int[] ids, CancellationToken cancellationToken)

IVideoPreviewWorkflow

Task<VideoPreviewViewData> GetVideoPreview(string mediaType, int id, CancellationToken cancellationToken)
Task<string> GetVideoUrl(string mediaType, int mediaId, string serverType, int serverId, CancellationToken cancellationToken)
Edit this page