C# Class VirtoCommerce.SwaggerApiClient.Api.CMSContentModuleApi

Represents a collection of functions to interact with the API endpoints

Inheritance: ICMSContentModuleApi

Datei anzeigen Open project: VirtoCommerce/vc-internal

Public Methods

Method	Description
CMSContentModuleApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the CMSContentModuleApi class.
CMSContentModuleApi ( String basePath ) : System	Initializes a new instance of the CMSContentModuleApi class.
GetBasePath ( ) : String	Gets the base path of the API client.
MenuCheckName ( string storeId, string name, string language, string id ) : VirtoCommerceContentWebModelsCheckNameResult	Checking name of menu link list Checking pair of name+language of menu link list for unique, if checking result - false saving unavailable
MenuCheckNameAsync ( string storeId, string name, string language, string id ) : System.Threading.Tasks.Task	Checking name of menu link list Checking pair of name+language of menu link list for unique, if checking result - false saving unavailable
MenuDelete ( string listId, string storeId ) : void	Delete menu link list
MenuDeleteAsync ( string listId, string storeId ) : System.Threading.Tasks.Task	Delete menu link list
MenuGetList ( string storeId, string listId ) : VirtoCommerceContentWebModelsMenuLinkList	Get menu link list by id
MenuGetListAsync ( string storeId, string listId ) : System.Threading.Tasks.Task	Get menu link list by id
MenuGetLists ( string storeId ) : List	Get menu link lists
MenuGetListsAsync ( string storeId ) : System.Threading.Tasks.Task>	Get menu link lists
MenuUpdate ( VirtoCommerceContentWebModelsMenuLinkList list, string storeId ) : void	Update menu link list
MenuUpdateAsync ( VirtoCommerceContentWebModelsMenuLinkList list, string storeId ) : System.Threading.Tasks.Task	Update menu link list
PagesCheckName ( string storeId, string pageName, string language ) : VirtoCommerceContentWebModelsCheckNameResult	Check page name Check page pair name+language for store
PagesCheckNameAsync ( string storeId, string pageName, string language ) : System.Threading.Tasks.Task	Check page name Check page pair name+language for store
PagesCreateBlog ( string storeId, string blogName ) : void
PagesCreateBlogAsync ( string storeId, string blogName ) : System.Threading.Tasks.Task
PagesDeleteBlog ( string storeId, string blogName ) : void
PagesDeleteBlogAsync ( string storeId, string blogName ) : System.Threading.Tasks.Task
PagesDeleteItem ( string storeId, List pageNamesAndLanguges ) : void	Delete page Delete pages with name+language pairs, that defined in pageNamesAndLanguges uri parameter
PagesDeleteItemAsync ( string storeId, List pageNamesAndLanguges ) : System.Threading.Tasks.Task	Delete page Delete pages with name+language pairs, that defined in pageNamesAndLanguges uri parameter
PagesGetFolders ( string storeId ) : VirtoCommerceContentWebModelsGetPagesResult	Get pages folders by store id
PagesGetFoldersAsync ( string storeId ) : System.Threading.Tasks.Task	Get pages folders by store id
PagesGetPage ( string storeId, string language, string pageName ) : VirtoCommerceContentWebModelsPage	Get page Get page by store and name+language pair.
PagesGetPageAsync ( string storeId, string language, string pageName ) : System.Threading.Tasks.Task	Get page Get page by store and name+language pair.
PagesGetPages ( string storeId, System.DateTime criteriaLastUpdateDate ) : List	Search pages Get all pages by store and criteria
PagesGetPagesAsync ( string storeId, System.DateTime criteriaLastUpdateDate ) : System.Threading.Tasks.Task>	Search pages Get all pages by store and criteria
PagesSaveItem ( string storeId, VirtoCommerceContentWebModelsPage page ) : void	Save page
PagesSaveItemAsync ( string storeId, VirtoCommerceContentWebModelsPage page ) : System.Threading.Tasks.Task	Save page
PagesUpdateBlog ( string storeId, string blogName, string oldBlogName ) : void
PagesUpdateBlogAsync ( string storeId, string blogName, string oldBlogName ) : System.Threading.Tasks.Task
SetBasePath ( String basePath ) : void	Sets the base path of the API client.
SyncSyncAssets ( string storeId, string theme, System.DateTime themeUpdated, System.DateTime pagesUpdated ) : List	Sync assets elements Method allows synchronize asset elements(theme assets and pages). For synchronization used store id, theme id and last theme and pages update date.\r\n If last update dates = null, returns all pages or theme assets for that store and theme.
SyncSyncAssetsAsync ( string storeId, string theme, System.DateTime themeUpdated, System.DateTime pagesUpdated ) : System.Threading.Tasks.Task>	Sync assets elements Method allows synchronize asset elements(theme assets and pages). For synchronization used store id, theme id and last theme and pages update date.\r\n If last update dates = null, returns all pages or theme assets for that store and theme.
ThemeCreateDefaultTheme ( string storeId ) : void	Create default theme by store id
ThemeCreateDefaultThemeAsync ( string storeId ) : System.Threading.Tasks.Task	Create default theme by store id
ThemeCreateNewTheme ( string storeId, string themeFileUrl, string themeName ) : void	Create new theme Create new theme considering store id, theme file url and theme name
ThemeCreateNewThemeAsync ( string storeId, string themeFileUrl, string themeName ) : System.Threading.Tasks.Task	Create new theme Create new theme considering store id, theme file url and theme name
ThemeDeleteAssets ( string storeId, string themeId, List assetIds ) : void	Delete theme assets by assetIds Delete theme assets considering store id, theme id and assetIds
ThemeDeleteAssetsAsync ( string storeId, string themeId, List assetIds ) : System.Threading.Tasks.Task	Delete theme assets by assetIds Delete theme assets considering store id, theme id and assetIds
ThemeDeleteTheme ( string storeId, string themeId ) : void	Delete theme Search theme assets by store id and theme id
ThemeDeleteThemeAsync ( string storeId, string themeId ) : System.Threading.Tasks.Task	Delete theme Search theme assets by store id and theme id
ThemeGetThemeAsset ( string assetId, string storeId, string themeId ) : void	Get theme asset Get theme asset by store id, theme id and asset id. Asset id - asset path relative to root theme path
ThemeGetThemeAssetAsync ( string assetId, string storeId, string themeId ) : System.Threading.Tasks.Task	Get theme asset Get theme asset by store id, theme id and asset id. Asset id - asset path relative to root theme path
ThemeGetThemeAssets ( string storeId, string themeId ) : List	Get theme assets folders Get theme assets folders by store id and theme id
ThemeGetThemeAssetsAsync ( string storeId, string themeId ) : System.Threading.Tasks.Task>	Get theme assets folders Get theme assets folders by store id and theme id
ThemeGetThemes ( string storeId ) : List	Get themes by store id
ThemeGetThemesAsync ( string storeId ) : System.Threading.Tasks.Task>	Get themes by store id
ThemeSaveItem ( VirtoCommerceContentWebModelsThemeAsset asset, string storeId, string themeId ) : void	Save theme asset Save theme asset considering store id and theme id
ThemeSaveItemAsync ( VirtoCommerceContentWebModelsThemeAsset asset, string storeId, string themeId ) : System.Threading.Tasks.Task	Save theme asset Save theme asset considering store id and theme id
ThemeSearchThemeAssets ( string storeId, string themeId, bool criteriaLoadContent, System.DateTime criteriaLastUpdateDate ) : List	Search theme assets Search theme assets by store id, theme id and criteria
ThemeSearchThemeAssetsAsync ( string storeId, string themeId, bool criteriaLoadContent, System.DateTime criteriaLastUpdateDate ) : System.Threading.Tasks.Task>	Search theme assets Search theme assets by store id, theme id and criteria

Method Details

CMSContentModuleApi() public method

Initializes a new instance of the CMSContentModuleApi class.

public CMSContentModuleApi ( ApiClient apiClient = null ) : System
apiClient	VirtoCommerce.SwaggerApiClient.Client.ApiClient	an instance of ApiClient (optional)
return	System

CMSContentModuleApi() public method

Initializes a new instance of the CMSContentModuleApi class.

public CMSContentModuleApi ( String basePath ) : System
basePath	String
return	System

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String

MenuCheckName() public method

Checking name of menu link list Checking pair of name+language of menu link list for unique, if checking result - false saving unavailable

public MenuCheckName ( string storeId, string name, string language, string id ) : VirtoCommerceContentWebModelsCheckNameResult
storeId	string	Store id
name	string	Name of menu link list
language	string	Language of menu link list
id	string	Menu link list id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsCheckNameResult

MenuCheckNameAsync() public method

Checking name of menu link list Checking pair of name+language of menu link list for unique, if checking result - false saving unavailable

public MenuCheckNameAsync ( string storeId, string name, string language, string id ) : System.Threading.Tasks.Task
storeId	string	Store id
name	string	Name of menu link list
language	string	Language of menu link list
id	string	Menu link list id
return	System.Threading.Tasks.Task

MenuDelete() public method

Delete menu link list

public MenuDelete ( string listId, string storeId ) : void
listId	string	Menu link list id
storeId	string
return	void

MenuDeleteAsync() public method

Delete menu link list

public MenuDeleteAsync ( string listId, string storeId ) : System.Threading.Tasks.Task
listId	string	Menu link list id
storeId	string
return	System.Threading.Tasks.Task

MenuGetList() public method

Get menu link list by id

public MenuGetList ( string storeId, string listId ) : VirtoCommerceContentWebModelsMenuLinkList
storeId	string	Store id
listId	string	List id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsMenuLinkList

MenuGetListAsync() public method

Get menu link list by id

public MenuGetListAsync ( string storeId, string listId ) : System.Threading.Tasks.Task
storeId	string	Store id
listId	string	List id
return	System.Threading.Tasks.Task

MenuGetLists() public method

Get menu link lists

public MenuGetLists ( string storeId ) : List
storeId	string	Store id
return	List

MenuGetListsAsync() public method

Get menu link lists

public MenuGetListsAsync ( string storeId ) : System.Threading.Tasks.Task>
storeId	string	Store id
return	System.Threading.Tasks.Task>

MenuUpdate() public method

Update menu link list

public MenuUpdate ( VirtoCommerceContentWebModelsMenuLinkList list, string storeId ) : void
list	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsMenuLinkList	Menu link list
storeId	string
return	void

MenuUpdateAsync() public method

Update menu link list

public MenuUpdateAsync ( VirtoCommerceContentWebModelsMenuLinkList list, string storeId ) : System.Threading.Tasks.Task
list	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsMenuLinkList	Menu link list
storeId	string
return	System.Threading.Tasks.Task

PagesCheckName() public method

Check page name Check page pair name+language for store

public PagesCheckName ( string storeId, string pageName, string language ) : VirtoCommerceContentWebModelsCheckNameResult
storeId	string	Store Id
pageName	string	Page name
language	string	Page language
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsCheckNameResult

PagesCheckNameAsync() public method

Check page name Check page pair name+language for store

public PagesCheckNameAsync ( string storeId, string pageName, string language ) : System.Threading.Tasks.Task
storeId	string	Store Id
pageName	string	Page name
language	string	Page language
return	System.Threading.Tasks.Task

PagesCreateBlog() public method

public PagesCreateBlog ( string storeId, string blogName ) : void
storeId	string
blogName	string
return	void

PagesCreateBlogAsync() public method

public PagesCreateBlogAsync ( string storeId, string blogName ) : System.Threading.Tasks.Task
storeId	string
blogName	string
return	System.Threading.Tasks.Task

PagesDeleteBlog() public method

public PagesDeleteBlog ( string storeId, string blogName ) : void
storeId	string
blogName	string
return	void

PagesDeleteBlogAsync() public method

public PagesDeleteBlogAsync ( string storeId, string blogName ) : System.Threading.Tasks.Task
storeId	string
blogName	string
return	System.Threading.Tasks.Task

PagesDeleteItem() public method

Delete page Delete pages with name+language pairs, that defined in pageNamesAndLanguges uri parameter

public PagesDeleteItem ( string storeId, List pageNamesAndLanguges ) : void
storeId	string	Store Id
pageNamesAndLanguges	List	Array of pairs name+language
return	void

PagesDeleteItemAsync() public method

Delete page Delete pages with name+language pairs, that defined in pageNamesAndLanguges uri parameter

public PagesDeleteItemAsync ( string storeId, List pageNamesAndLanguges ) : System.Threading.Tasks.Task
storeId	string	Store Id
pageNamesAndLanguges	List	Array of pairs name+language
return	System.Threading.Tasks.Task

PagesGetFolders() public method

Get pages folders by store id

public PagesGetFolders ( string storeId ) : VirtoCommerceContentWebModelsGetPagesResult
storeId	string	Store Id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsGetPagesResult

PagesGetFoldersAsync() public method

Get pages folders by store id

public PagesGetFoldersAsync ( string storeId ) : System.Threading.Tasks.Task
storeId	string	Store Id
return	System.Threading.Tasks.Task

PagesGetPage() public method

Get page Get page by store and name+language pair.

public PagesGetPage ( string storeId, string language, string pageName ) : VirtoCommerceContentWebModelsPage
storeId	string	Store Id
language	string	Page language
pageName	string	Page name
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsPage

PagesGetPageAsync() public method

Get page Get page by store and name+language pair.

public PagesGetPageAsync ( string storeId, string language, string pageName ) : System.Threading.Tasks.Task
storeId	string	Store Id
language	string	Page language
pageName	string	Page name
return	System.Threading.Tasks.Task

PagesGetPages() public method

Search pages Get all pages by store and criteria

public PagesGetPages ( string storeId, System.DateTime criteriaLastUpdateDate ) : List
storeId	string	Store Id
criteriaLastUpdateDate	System.DateTime	Max value of last updated date, if it's null returns all pages for store
return	List

PagesGetPagesAsync() public method

Search pages Get all pages by store and criteria

public PagesGetPagesAsync ( string storeId, System.DateTime criteriaLastUpdateDate ) : System.Threading.Tasks.Task>
storeId	string	Store Id
criteriaLastUpdateDate	System.DateTime	Max value of last updated date, if it's null returns all pages for store
return	System.Threading.Tasks.Task>

PagesSaveItem() public method

Save page

public PagesSaveItem ( string storeId, VirtoCommerceContentWebModelsPage page ) : void
storeId	string	Store Id
page	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsPage	Page
return	void

PagesSaveItemAsync() public method

Save page

public PagesSaveItemAsync ( string storeId, VirtoCommerceContentWebModelsPage page ) : System.Threading.Tasks.Task
storeId	string	Store Id
page	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsPage	Page
return	System.Threading.Tasks.Task

PagesUpdateBlog() public method

public PagesUpdateBlog ( string storeId, string blogName, string oldBlogName ) : void
storeId	string
blogName	string
oldBlogName	string
return	void

PagesUpdateBlogAsync() public method

public PagesUpdateBlogAsync ( string storeId, string blogName, string oldBlogName ) : System.Threading.Tasks.Task
storeId	string
blogName	string
oldBlogName	string
return	System.Threading.Tasks.Task

SetBasePath() public method

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String	The base path
return	void

SyncSyncAssets() public method

Sync assets elements Method allows synchronize asset elements(theme assets and pages). For synchronization used store id, theme id and last theme and pages update date.\r\n If last update dates = null, returns all pages or theme assets for that store and theme.

public SyncSyncAssets ( string storeId, string theme, System.DateTime themeUpdated, System.DateTime pagesUpdated ) : List
storeId	string	Store id
theme	string	Theme name
themeUpdated	System.DateTime	Last theme updated date
pagesUpdated	System.DateTime	Last pages updated date
return	List

SyncSyncAssetsAsync() public method

public SyncSyncAssetsAsync ( string storeId, string theme, System.DateTime themeUpdated, System.DateTime pagesUpdated ) : System.Threading.Tasks.Task>
storeId	string	Store id
theme	string	Theme name
themeUpdated	System.DateTime	Last theme updated date
pagesUpdated	System.DateTime	Last pages updated date
return	System.Threading.Tasks.Task>

ThemeCreateDefaultTheme() public method

Create default theme by store id

public ThemeCreateDefaultTheme ( string storeId ) : void
storeId	string	Store id
return	void

ThemeCreateDefaultThemeAsync() public method

Create default theme by store id

public ThemeCreateDefaultThemeAsync ( string storeId ) : System.Threading.Tasks.Task
storeId	string	Store id
return	System.Threading.Tasks.Task

ThemeCreateNewTheme() public method

Create new theme Create new theme considering store id, theme file url and theme name

public ThemeCreateNewTheme ( string storeId, string themeFileUrl, string themeName ) : void
storeId	string	Store id
themeFileUrl	string	Theme file url
themeName	string	Theme name
return	void

ThemeCreateNewThemeAsync() public method

Create new theme Create new theme considering store id, theme file url and theme name

public ThemeCreateNewThemeAsync ( string storeId, string themeFileUrl, string themeName ) : System.Threading.Tasks.Task
storeId	string	Store id
themeFileUrl	string	Theme file url
themeName	string	Theme name
return	System.Threading.Tasks.Task

ThemeDeleteAssets() public method

Delete theme assets by assetIds Delete theme assets considering store id, theme id and assetIds

public ThemeDeleteAssets ( string storeId, string themeId, List assetIds ) : void
storeId	string	Store id
themeId	string	Theme id
assetIds	List	Deleted asset ids
return	void

ThemeDeleteAssetsAsync() public method

Delete theme assets by assetIds Delete theme assets considering store id, theme id and assetIds

public ThemeDeleteAssetsAsync ( string storeId, string themeId, List assetIds ) : System.Threading.Tasks.Task
storeId	string	Store id
themeId	string	Theme id
assetIds	List	Deleted asset ids
return	System.Threading.Tasks.Task

ThemeDeleteTheme() public method

Delete theme Search theme assets by store id and theme id

public ThemeDeleteTheme ( string storeId, string themeId ) : void
storeId	string	Store id
themeId	string	Theme id
return	void

ThemeDeleteThemeAsync() public method

Delete theme Search theme assets by store id and theme id

public ThemeDeleteThemeAsync ( string storeId, string themeId ) : System.Threading.Tasks.Task
storeId	string	Store id
themeId	string	Theme id
return	System.Threading.Tasks.Task

ThemeGetThemeAsset() public method

Get theme asset Get theme asset by store id, theme id and asset id. Asset id - asset path relative to root theme path

public ThemeGetThemeAsset ( string assetId, string storeId, string themeId ) : void
assetId	string	Theme asset id
storeId	string	Store id
themeId	string	Theme id
return	void

ThemeGetThemeAssetAsync() public method

Get theme asset Get theme asset by store id, theme id and asset id. Asset id - asset path relative to root theme path

public ThemeGetThemeAssetAsync ( string assetId, string storeId, string themeId ) : System.Threading.Tasks.Task
assetId	string	Theme asset id
storeId	string	Store id
themeId	string	Theme id
return	System.Threading.Tasks.Task

ThemeGetThemeAssets() public method

Get theme assets folders Get theme assets folders by store id and theme id

public ThemeGetThemeAssets ( string storeId, string themeId ) : List
storeId	string	Store id
themeId	string	Theme id
return	List

ThemeGetThemeAssetsAsync() public method

Get theme assets folders Get theme assets folders by store id and theme id

public ThemeGetThemeAssetsAsync ( string storeId, string themeId ) : System.Threading.Tasks.Task>
storeId	string	Store id
themeId	string	Theme id
return	System.Threading.Tasks.Task>

ThemeGetThemes() public method

Get themes by store id

public ThemeGetThemes ( string storeId ) : List
storeId	string	Store id
return	List

ThemeGetThemesAsync() public method

Get themes by store id

public ThemeGetThemesAsync ( string storeId ) : System.Threading.Tasks.Task>
storeId	string	Store id
return	System.Threading.Tasks.Task>

ThemeSaveItem() public method

Save theme asset Save theme asset considering store id and theme id

public ThemeSaveItem ( VirtoCommerceContentWebModelsThemeAsset asset, string storeId, string themeId ) : void
asset	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsThemeAsset	Theme asset
storeId	string	Store id
themeId	string	Theme id
return	void

ThemeSaveItemAsync() public method

Save theme asset Save theme asset considering store id and theme id

public ThemeSaveItemAsync ( VirtoCommerceContentWebModelsThemeAsset asset, string storeId, string themeId ) : System.Threading.Tasks.Task
asset	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceContentWebModelsThemeAsset	Theme asset
storeId	string	Store id
themeId	string	Theme id
return	System.Threading.Tasks.Task

ThemeSearchThemeAssets() public method

Search theme assets Search theme assets by store id, theme id and criteria

public ThemeSearchThemeAssets ( string storeId, string themeId, bool criteriaLoadContent, System.DateTime criteriaLastUpdateDate ) : List
storeId	string	Store id
themeId	string	Theme id
criteriaLoadContent	bool	If true - returns array of theme assets including binary or text content, if false - returns array of theme assets without content
criteriaLastUpdateDate	System.DateTime	Max value of last updated date, if it's null returns all pages for store
return	List

ThemeSearchThemeAssetsAsync() public method

Search theme assets Search theme assets by store id, theme id and criteria

public ThemeSearchThemeAssetsAsync ( string storeId, string themeId, bool criteriaLoadContent, System.DateTime criteriaLastUpdateDate ) : System.Threading.Tasks.Task>
storeId	string	Store id
themeId	string	Theme id
criteriaLoadContent	bool	If true - returns array of theme assets including binary or text content, if false - returns array of theme assets without content
criteriaLastUpdateDate	System.DateTime	Max value of last updated date, if it's null returns all pages for store
return	System.Threading.Tasks.Task>