Interface IBrandingManager

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

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

public interface IBrandingManager

Methods

GetAvailableThemes()

Lists the available themes for this web

List<ITheme> GetAvailableThemes()

Returns

List<ITheme>

List of IThemeinstances

GetAvailableThemesAsync()

Lists the available themes for this web

Task<List<ITheme>> GetAvailableThemesAsync()

Returns

Task<List<ITheme>>

List of IThemeinstances

GetAvailableThemesBatch()

Lists the available themes for this web

IEnumerableBatchResult<ITheme> GetAvailableThemesBatch()

Returns

IEnumerableBatchResult<ITheme>

List of IThemeinstances

GetAvailableThemesBatch(Batch)

Lists the available themes for this web

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

Task<IEnumerableBatchResult<ITheme>> GetAvailableThemesBatchAsync()

Returns

Task<IEnumerableBatchResult<ITheme>>

List of IThemeinstances

GetAvailableThemesBatchAsync(Batch)

Lists the available themes for this web

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

IChromeOptions GetChromeOptions()

Returns

IChromeOptions

Site's IChromeOptions

GetChromeOptionsAsync()

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

Task<IChromeOptions> GetChromeOptionsAsync()

Returns

Task<IChromeOptions>

Site's IChromeOptions

GetChromeOptionsBatch()

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

IBatchSingleResult<IChromeOptions> GetChromeOptionsBatch()

Returns

IBatchSingleResult<IChromeOptions>

Site's IChromeOptions

GetChromeOptionsBatch(Batch)

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

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

Task<IBatchSingleResult<IChromeOptions>> GetChromeOptionsBatchAsync()

Returns

Task<IBatchSingleResult<IChromeOptions>>

Site's IChromeOptions

GetChromeOptionsBatchAsync(Batch)

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

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

void SetChromeOptions(IChromeOptions chromeOptions)

Parameters

chromeOptions IChromeOptions

Site chrome options to apply

SetChromeOptionsAsync(IChromeOptions)

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

Task SetChromeOptionsAsync(IChromeOptions chromeOptions)

Parameters

chromeOptions IChromeOptions

Site chrome options to apply

Returns

Task

SetChromeOptionsBatch(IChromeOptions)

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

void SetChromeOptionsBatch(IChromeOptions chromeOptions)

Parameters

chromeOptions IChromeOptions

Site chrome options to apply

SetChromeOptionsBatch(Batch, IChromeOptions)

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

void SetChromeOptionsBatch(Batch batch, IChromeOptions chromeOptions)

Parameters

batch Batch

Batch to add this request to

chromeOptions IChromeOptions

Site chrome options to apply

SetChromeOptionsBatchAsync(IChromeOptions)

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

Task SetChromeOptionsBatchAsync(IChromeOptions chromeOptions)

Parameters

chromeOptions IChromeOptions

Site chrome options to apply

Returns

Task

SetChromeOptionsBatchAsync(Batch, IChromeOptions)

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

Task SetChromeOptionsBatchAsync(Batch batch, IChromeOptions chromeOptions)

Parameters

batch Batch

Batch to add this request to

chromeOptions IChromeOptions

Site chrome options to apply

Returns

Task

SetTheme(ITheme)

Sets a custom theme

void SetTheme(ITheme theme)

Parameters

theme ITheme

Theme to apply

SetTheme(SharePointTheme)

Sets a an out of the box theme

void SetTheme(SharePointTheme theme)

Parameters

theme SharePointTheme

Theme to apply

SetThemeAsync(ITheme)

Sets a custom theme

Task SetThemeAsync(ITheme theme)

Parameters

theme ITheme

Theme to apply

Returns

Task

SetThemeAsync(SharePointTheme)

Sets a an out of the box theme

Task SetThemeAsync(SharePointTheme theme)

Parameters

theme SharePointTheme

Theme to apply

Returns

Task

SetThemeBatch(ITheme)

Sets a custom theme

void SetThemeBatch(ITheme theme)

Parameters

theme ITheme

Theme to apply

SetThemeBatch(SharePointTheme)

Sets a an out of the box theme

void SetThemeBatch(SharePointTheme theme)

Parameters

theme SharePointTheme

Theme to apply

SetThemeBatch(Batch, ITheme)

Sets a custom theme

void SetThemeBatch(Batch batch, ITheme theme)

Parameters

batch Batch

Batch to add this request to

theme ITheme

Theme to apply

SetThemeBatch(Batch, SharePointTheme)

Sets a an out of the box theme

void SetThemeBatch(Batch batch, SharePointTheme theme)

Parameters

batch Batch

Batch to add this request to

theme SharePointTheme

Theme to apply

SetThemeBatchAsync(ITheme)

Sets a custom theme

Task SetThemeBatchAsync(ITheme theme)

Parameters

theme ITheme

Theme to apply

Returns

Task

SetThemeBatchAsync(SharePointTheme)

Sets a an out of the box theme

Task SetThemeBatchAsync(SharePointTheme theme)

Parameters

theme SharePointTheme

Theme to apply

Returns

Task

SetThemeBatchAsync(Batch, ITheme)

Sets a custom theme

Task SetThemeBatchAsync(Batch batch, ITheme theme)

Parameters

batch Batch

Batch to add this request to

theme ITheme

Theme to apply

Returns

Task

SetThemeBatchAsync(Batch, SharePointTheme)

Sets a an out of the box theme

Task SetThemeBatchAsync(Batch batch, SharePointTheme theme)

Parameters

batch Batch

Batch to add this request to

theme SharePointTheme

Theme to apply

Returns

Task