Interface IBrandingManager

Enables branding changes for the site (the options that appear under "change the look" under the gear icon in SharePoint)

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IBrandingManager

Methods

GetAvailableThemes()

Lists the available themes for this web

Declaration

List<ITheme> GetAvailableThemes()

Returns

PnP.Core.Model.SharePoint.List<ITheme> List of IThemeinstances

GetAvailableThemesAsync()

Lists the available themes for this web

Declaration

Task<List<ITheme>> GetAvailableThemesAsync()

Returns

Task<PnP.Core.Model.SharePoint.List<ITheme>> List of IThemeinstances

GetAvailableThemesBatch()

Lists the available themes for this web

Declaration

IEnumerableBatchResult<ITheme> GetAvailableThemesBatch()

Returns

IEnumerableBatchResult<ITheme> List of IThemeinstances

GetAvailableThemesBatch(Batch)

Lists the available themes for this web

Declaration

IEnumerableBatchResult<ITheme> GetAvailableThemesBatch(Batch batch)

Parameters

Batch batch Batch to add this request to

Returns

IEnumerableBatchResult<ITheme> List of IThemeinstances

GetAvailableThemesBatchAsync()

Lists the available themes for this web

Declaration

Task<IEnumerableBatchResult<ITheme>> GetAvailableThemesBatchAsync()

Returns

Task<IEnumerableBatchResult<ITheme>> List of IThemeinstances

GetAvailableThemesBatchAsync(Batch)

Lists the available themes for this web

Declaration

Task<IEnumerableBatchResult<ITheme>> GetAvailableThemesBatchAsync(Batch batch)

Parameters

Batch batch Batch to add this request to

Returns

Task<IEnumerableBatchResult<ITheme>> List of IThemeinstances

GetChromeOptions()

Gets the site's chrome (header/footer/navigation) options

Declaration

IChromeOptions GetChromeOptions()

Returns

IChromeOptions Site's IChromeOptions

GetChromeOptionsAsync()

Gets the site's chrome (header/footer/navigation) options

Declaration

Task<IChromeOptions> GetChromeOptionsAsync()

Returns

Task<IChromeOptions> Site's IChromeOptions

GetChromeOptionsBatch()

Gets the site's chrome (header/footer/navigation) options

Declaration

IBatchSingleResult<IChromeOptions> GetChromeOptionsBatch()

Returns

IBatchSingleResult<IChromeOptions> Site's IChromeOptions

GetChromeOptionsBatch(Batch)

Gets the site's chrome (header/footer/navigation) options

Declaration

IBatchSingleResult<IChromeOptions> GetChromeOptionsBatch(Batch batch)

Parameters

Batch batch Batch to add this request to

Returns

IBatchSingleResult<IChromeOptions> Site's IChromeOptions

GetChromeOptionsBatchAsync()

Gets the site's chrome (header/footer/navigation) options

Declaration

Task<IBatchSingleResult<IChromeOptions>> GetChromeOptionsBatchAsync()

Returns

Task<IBatchSingleResult<IChromeOptions>> Site's IChromeOptions

GetChromeOptionsBatchAsync(Batch)

Gets the site's chrome (header/footer/navigation) options

Declaration

Task<IBatchSingleResult<IChromeOptions>> GetChromeOptionsBatchAsync(Batch batch)

Parameters

Batch batch Batch to add this request to

Returns

Task<IBatchSingleResult<IChromeOptions>> Site's IChromeOptions

SetChromeOptions(IChromeOptions)

Sets the site's chrome (header/footer/navigation) options

Declaration

void SetChromeOptions(IChromeOptions chromeOptions)

Parameters

IChromeOptions chromeOptions Site chrome options to apply

SetChromeOptionsAsync(IChromeOptions)

Sets the site's chrome (header/footer/navigation) options

Declaration

Task SetChromeOptionsAsync(IChromeOptions chromeOptions)

Parameters

IChromeOptions chromeOptions Site chrome options to apply

Returns

Task

SetChromeOptionsBatch(IChromeOptions)

Sets the site's chrome (header/footer/navigation) options

Declaration

void SetChromeOptionsBatch(IChromeOptions chromeOptions)

Parameters

IChromeOptions chromeOptions Site chrome options to apply

SetChromeOptionsBatch(Batch, IChromeOptions)

Sets the site's chrome (header/footer/navigation) options

Declaration

void SetChromeOptionsBatch(Batch batch, IChromeOptions chromeOptions)

Parameters

Batch batch Batch to add this request to

IChromeOptions chromeOptions Site chrome options to apply

SetChromeOptionsBatchAsync(IChromeOptions)

Sets the site's chrome (header/footer/navigation) options

Declaration

Task SetChromeOptionsBatchAsync(IChromeOptions chromeOptions)

Parameters

IChromeOptions chromeOptions Site chrome options to apply

Returns

Task

SetChromeOptionsBatchAsync(Batch, IChromeOptions)

Sets the site's chrome (header/footer/navigation) options

Declaration

Task SetChromeOptionsBatchAsync(Batch batch, IChromeOptions chromeOptions)

Parameters

Batch batch Batch to add this request to

IChromeOptions chromeOptions Site chrome options to apply

Returns

Task

SetTheme(ITheme)

Sets a custom theme

Declaration

void SetTheme(ITheme theme)

Parameters

ITheme theme Theme to apply

SetTheme(SharePointTheme)

Sets a an out of the box theme

Declaration

void SetTheme(SharePointTheme theme)

Parameters

SharePointTheme theme Theme to apply

SetThemeAsync(ITheme)

Sets a custom theme

Declaration

Task SetThemeAsync(ITheme theme)

Parameters

ITheme theme Theme to apply

Returns

Task

SetThemeAsync(SharePointTheme)

Sets a an out of the box theme

Declaration

Task SetThemeAsync(SharePointTheme theme)

Parameters

SharePointTheme theme Theme to apply

Returns

Task

SetThemeBatch(ITheme)

Sets a custom theme

Declaration

void SetThemeBatch(ITheme theme)

Parameters

ITheme theme Theme to apply

SetThemeBatch(SharePointTheme)

Sets a an out of the box theme

Declaration

void SetThemeBatch(SharePointTheme theme)

Parameters

SharePointTheme theme Theme to apply

SetThemeBatch(Batch, ITheme)

Sets a custom theme

Declaration

void SetThemeBatch(Batch batch, ITheme theme)

Parameters

Batch batch Batch to add this request to

ITheme theme Theme to apply

SetThemeBatch(Batch, SharePointTheme)

Sets a an out of the box theme

Declaration

void SetThemeBatch(Batch batch, SharePointTheme theme)

Parameters

Batch batch Batch to add this request to

SharePointTheme theme Theme to apply

SetThemeBatchAsync(ITheme)

Sets a custom theme

Declaration

Task SetThemeBatchAsync(ITheme theme)

Parameters

ITheme theme Theme to apply

Returns

Task

SetThemeBatchAsync(SharePointTheme)

Sets a an out of the box theme

Declaration

Task SetThemeBatchAsync(SharePointTheme theme)

Parameters

SharePointTheme theme Theme to apply

Returns

Task

SetThemeBatchAsync(Batch, ITheme)

Sets a custom theme

Declaration

Task SetThemeBatchAsync(Batch batch, ITheme theme)

Parameters

Batch batch Batch to add this request to

ITheme theme Theme to apply

Returns

Task

SetThemeBatchAsync(Batch, SharePointTheme)

Sets a an out of the box theme

Declaration

Task SetThemeBatchAsync(Batch batch, SharePointTheme theme)

Parameters

Batch batch Batch to add this request to

SharePointTheme theme Theme to apply

Returns

Task