Class DefaultDisplayRequestBuilderExtensions

Inheritance

object

DefaultDisplayRequestBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Boomack.Client

Assembly: NBoomackClient.dll

Syntax

public static class DefaultDisplayRequestBuilderExtensions

Methods

Align(IDisplayRequestBuilder, Alignment)

Declaration

public static IDisplayRequestBuilder Align(this IDisplayRequestBuilder builder, Alignment alignment)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Alignment	alignment

Returns

Type	Description
IDisplayRequestBuilder

Append(IDisplayRequestBuilder)

Declaration

public static IDisplayRequestBuilder Append(this IDisplayRequestBuilder builder)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder

Returns

Type	Description
IDisplayRequestBuilder

Audio(IDisplayRequestBuilder, byte[], CommonAudioType, CacheMode?, bool?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder Audio(this IDisplayRequestBuilder builder, byte[] data, CommonAudioType type, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, bool? loop = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
byte[]	data
CommonAudioType	type
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
bool?	loop

Returns

Type	Description
IDisplayRequestBuilder

Audio(IDisplayRequestBuilder, Stream, CommonAudioType, CacheMode?, bool?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder Audio(this IDisplayRequestBuilder builder, Stream stream, CommonAudioType type, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, bool? loop = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Stream	stream
CommonAudioType	type
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
bool?	loop

Returns

Type	Description
IDisplayRequestBuilder

Code(IDisplayRequestBuilder, string, string)

Declaration

public static IDisplayRequestBuilder Code(this IDisplayRequestBuilder builder, string text, string language = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	text
string	language

Returns

Type	Description
IDisplayRequestBuilder

ConfigureDynamic(IDisplayRequestBuilder, Action<dynamic>)

Declaration

public static IDisplayRequestBuilder ConfigureDynamic(this IDisplayRequestBuilder builder, Action<dynamic> configurer)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Action<dynamic>	configurer

Returns

Type	Description
IDisplayRequestBuilder

Debug(IDisplayRequestBuilder, bool)

Declaration

public static IDisplayRequestBuilder Debug(this IDisplayRequestBuilder builder, bool debug = true)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
bool	debug

Returns

Type	Description
IDisplayRequestBuilder

Embed(IDisplayRequestBuilder)

Declaration

public static IDisplayRequestBuilder Embed(this IDisplayRequestBuilder builder)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder

Returns

Type	Description
IDisplayRequestBuilder

ExtendAt(IDisplayRequestBuilder, ExtensionMode)

Declaration

public static IDisplayRequestBuilder ExtendAt(this IDisplayRequestBuilder builder, ExtensionMode extensionMode)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
ExtensionMode	extensionMode

Returns

Type	Description
IDisplayRequestBuilder

Highlight(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder Highlight(this IDisplayRequestBuilder builder, string language)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	language

Returns

Type	Description
IDisplayRequestBuilder

Html(IDisplayRequestBuilder, string, bool?)

Declaration

public static IDisplayRequestBuilder Html(this IDisplayRequestBuilder builder, string html, bool? iFrame = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	html
bool?	iFrame

Returns

Type	Description
IDisplayRequestBuilder

Image(IDisplayRequestBuilder, byte[], CommonImageType, ScaleMode?, Alignment?, CacheMode?)

Declaration

public static IDisplayRequestBuilder Image(this IDisplayRequestBuilder builder, byte[] data, CommonImageType type, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
byte[]	data
CommonImageType	type
ScaleMode?	scale
Alignment?	align
CacheMode?	cache

Returns

Type	Description
IDisplayRequestBuilder

Image(IDisplayRequestBuilder, Stream, CommonImageType, ScaleMode?, Alignment?, CacheMode?)

Declaration

public static IDisplayRequestBuilder Image(this IDisplayRequestBuilder builder, Stream stream, CommonImageType type, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Stream	stream
CommonImageType	type
ScaleMode?	scale
Alignment?	align
CacheMode?	cache

Returns

Type	Description
IDisplayRequestBuilder

InIFrame(IDisplayRequestBuilder, bool)

Declaration

public static IDisplayRequestBuilder InIFrame(this IDisplayRequestBuilder builder, bool iFrame = true)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
bool	iFrame

Returns

Type	Description
IDisplayRequestBuilder

Json<T>(IDisplayRequestBuilder, T, string, JsonSerializerSettings)

Declaration

public static IDisplayRequestBuilder Json<T>(this IDisplayRequestBuilder builder, T data, string contentType = "application/json", JsonSerializerSettings jsonSettings = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
T	data
string	contentType
JsonSerializerSettings	jsonSettings

Returns

Type	Description
IDisplayRequestBuilder

Type Parameters

Name	Description
T

LocalAudioFile(IDisplayRequestBuilder, string, string, CacheMode?, bool?, bool?, int?, bool?)

Declaration

public static IDisplayRequestBuilder LocalAudioFile(this IDisplayRequestBuilder builder, string path, string contentType = null, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, int? startPos = null, bool? loop = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
int?	startPos
bool?	loop

Returns

Type	Description
IDisplayRequestBuilder

LocalCodeFile(IDisplayRequestBuilder, string, string)

Declaration

public static IDisplayRequestBuilder LocalCodeFile(this IDisplayRequestBuilder builder, string path, string language = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	language

Returns

Type	Description
IDisplayRequestBuilder

LocalFile(IDisplayRequestBuilder, string, string, CacheMode?)

Declaration

public static IDisplayRequestBuilder LocalFile(this IDisplayRequestBuilder builder, string path, string contentType = null, CacheMode? cacheMode = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
CacheMode?	cacheMode

Returns

Type	Description
IDisplayRequestBuilder

LocalHtmlFile(IDisplayRequestBuilder, string, bool?)

Declaration

public static IDisplayRequestBuilder LocalHtmlFile(this IDisplayRequestBuilder builder, string path, bool? iFrame = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
bool?	iFrame

Returns

Type	Description
IDisplayRequestBuilder

LocalImageFile(IDisplayRequestBuilder, string, string, ScaleMode?, Alignment?, CacheMode?)

Declaration

public static IDisplayRequestBuilder LocalImageFile(this IDisplayRequestBuilder builder, string path, string contentType = null, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
ScaleMode?	scale
Alignment?	align
CacheMode?	cache

Returns

Type	Description
IDisplayRequestBuilder

LocalTextFile(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder LocalTextFile(this IDisplayRequestBuilder builder, string path)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path

Returns

Type	Description
IDisplayRequestBuilder

LocalVideoFile(IDisplayRequestBuilder, string, string, ScaleMode?, Alignment?, CacheMode?, bool?, bool?, int?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder LocalVideoFile(this IDisplayRequestBuilder builder, string path, string contentType = null, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, int? startPos = null, bool? loop = null, bool? muted = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
ScaleMode?	scale
Alignment?	align
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
int?	startPos
bool?	loop
bool?	muted

Returns

Type	Description
IDisplayRequestBuilder

Prepend(IDisplayRequestBuilder)

Declaration

public static IDisplayRequestBuilder Prepend(this IDisplayRequestBuilder builder)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder

Returns

Type	Description
IDisplayRequestBuilder

ProbeUrlMediaType(IDisplayRequestBuilder, TimeSpan?)

Declaration

public static IDisplayRequestBuilder ProbeUrlMediaType(this IDisplayRequestBuilder builder, TimeSpan? timeout = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
TimeSpan?	timeout

Returns

Type	Description
IDisplayRequestBuilder

RemoteAudio(IDisplayRequestBuilder, string, CommonAudioType?, CacheMode?, TimeSpan?, bool?, bool?, int?, bool?)

Declaration

public static IDisplayRequestBuilder RemoteAudio(this IDisplayRequestBuilder builder, string url, CommonAudioType? type = null, CacheMode? cache = null, TimeSpan? timeout = null, bool? mediaControls = null, bool? autoplay = true, int? startPos = null, bool? loop = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	url
CommonAudioType?	type
CacheMode?	cache
TimeSpan?	timeout
bool?	mediaControls
bool?	autoplay
int?	startPos
bool?	loop

Returns

Type	Description
IDisplayRequestBuilder

RemoteContent(IDisplayRequestBuilder, string, string, bool?)

Declaration

public static IDisplayRequestBuilder RemoteContent(this IDisplayRequestBuilder builder, string url, string contentType = null, bool? iFrame = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	url
string	contentType
bool?	iFrame

Returns

Type	Description
IDisplayRequestBuilder

RemoteContent(IDisplayRequestBuilder, Uri, string, bool?, TimeSpan?)

Declaration

public static IDisplayRequestBuilder RemoteContent(this IDisplayRequestBuilder builder, Uri url, string contentType = null, bool? iFrame = null, TimeSpan? timeout = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Uri	url
string	contentType
bool?	iFrame
TimeSpan?	timeout

Returns

Type	Description
IDisplayRequestBuilder

RemoteImage(IDisplayRequestBuilder, string, CommonImageType?, ScaleMode?, Alignment?, CacheMode?, TimeSpan?)

Declaration

public static IDisplayRequestBuilder RemoteImage(this IDisplayRequestBuilder builder, string url, CommonImageType? type = null, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null, TimeSpan? timeout = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	url
CommonImageType?	type
ScaleMode?	scale
Alignment?	align
CacheMode?	cache
TimeSpan?	timeout

Returns

Type	Description
IDisplayRequestBuilder

RemoteVideo(IDisplayRequestBuilder, string, CommonVideoType?, ScaleMode?, Alignment?, CacheMode?, TimeSpan?, bool?, bool?, int?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder RemoteVideo(this IDisplayRequestBuilder builder, string url, CommonVideoType? type = null, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null, TimeSpan? timeout = null, bool? mediaControls = null, bool? autoplay = true, int? startPos = null, bool? loop = null, bool? muted = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	url
CommonVideoType?	type
ScaleMode?	scale
Alignment?	align
CacheMode?	cache
TimeSpan?	timeout
bool?	mediaControls
bool?	autoplay
int?	startPos
bool?	loop
bool?	muted

Returns

Type	Description
IDisplayRequestBuilder

Scale(IDisplayRequestBuilder, ScaleMode)

Declaration

public static IDisplayRequestBuilder Scale(this IDisplayRequestBuilder builder, ScaleMode scaleMode)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
ScaleMode	scaleMode

Returns

Type	Description
IDisplayRequestBuilder

ServerAudioFile(IDisplayRequestBuilder, string, string, CacheMode?, bool?, bool?, int?, bool?)

Declaration

public static IDisplayRequestBuilder ServerAudioFile(this IDisplayRequestBuilder builder, string path, string contentType = null, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, int? startPos = null, bool? loop = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
int?	startPos
bool?	loop

Returns

Type	Description
IDisplayRequestBuilder

ServerCodeFile(IDisplayRequestBuilder, string, string)

Declaration

public static IDisplayRequestBuilder ServerCodeFile(this IDisplayRequestBuilder builder, string path, string language = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	language

Returns

Type	Description
IDisplayRequestBuilder

ServerFile(IDisplayRequestBuilder, string, string)

Declaration

public static IDisplayRequestBuilder ServerFile(this IDisplayRequestBuilder builder, string path, string contentType = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType

Returns

Type	Description
IDisplayRequestBuilder

ServerHtmlFile(IDisplayRequestBuilder, string, bool?)

Declaration

public static IDisplayRequestBuilder ServerHtmlFile(this IDisplayRequestBuilder builder, string path, bool? iFrame = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
bool?	iFrame

Returns

Type	Description
IDisplayRequestBuilder

ServerImageFile(IDisplayRequestBuilder, string, string, ScaleMode?, Alignment?, CacheMode?)

Declaration

public static IDisplayRequestBuilder ServerImageFile(this IDisplayRequestBuilder builder, string path, string contentType = null, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
ScaleMode?	scale
Alignment?	align
CacheMode?	cache

Returns

Type	Description
IDisplayRequestBuilder

ServerTextFile(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder ServerTextFile(this IDisplayRequestBuilder builder, string path)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path

Returns

Type	Description
IDisplayRequestBuilder

ServerVideoFile(IDisplayRequestBuilder, string, string, ScaleMode?, Alignment?, CacheMode?, bool?, bool?, int?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder ServerVideoFile(this IDisplayRequestBuilder builder, string path, string contentType = null, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, int? startPos = null, bool? loop = null, bool? muted = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	contentType
ScaleMode?	scale
Alignment?	align
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
int?	startPos
bool?	loop
bool?	muted

Returns

Type	Description
IDisplayRequestBuilder

Url(IDisplayRequestBuilder, string, string, bool?)

Declaration

public static IDisplayRequestBuilder Url(this IDisplayRequestBuilder builder, string url, string contentType = "application/octet-stream", bool? iFrame = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	url
string	contentType
bool?	iFrame

Returns

Type	Description
IDisplayRequestBuilder

Video(IDisplayRequestBuilder, byte[], CommonVideoType, ScaleMode?, Alignment?, CacheMode?, bool?, bool?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder Video(this IDisplayRequestBuilder builder, byte[] data, CommonVideoType type, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, bool? loop = null, bool? muted = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
byte[]	data
CommonVideoType	type
ScaleMode?	scale
Alignment?	align
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
bool?	loop
bool?	muted

Returns

Type	Description
IDisplayRequestBuilder

Video(IDisplayRequestBuilder, Stream, CommonVideoType, ScaleMode?, Alignment?, CacheMode?, bool?, bool?, bool?, bool?)

Declaration

public static IDisplayRequestBuilder Video(this IDisplayRequestBuilder builder, Stream stream, CommonVideoType type, ScaleMode? scale = null, Alignment? align = null, CacheMode? cache = null, bool? mediaControls = null, bool? autoplay = true, bool? loop = null, bool? muted = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Stream	stream
CommonVideoType	type
ScaleMode?	scale
Alignment?	align
CacheMode?	cache
bool?	mediaControls
bool?	autoplay
bool?	loop
bool?	muted

Returns

Type	Description
IDisplayRequestBuilder

Website(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder Website(this IDisplayRequestBuilder builder, string url)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	url

Returns

Type	Description
IDisplayRequestBuilder

Website(IDisplayRequestBuilder, Uri)

Declaration

public static IDisplayRequestBuilder Website(this IDisplayRequestBuilder builder, Uri url)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
Uri	url

Returns

Type	Description
IDisplayRequestBuilder

WithBackground(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder WithBackground(this IDisplayRequestBuilder builder, string cssBackground)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	cssBackground

Returns

Type	Description
IDisplayRequestBuilder

WithCache(IDisplayRequestBuilder, CacheMode?)

Declaration

public static IDisplayRequestBuilder WithCache(this IDisplayRequestBuilder builder, CacheMode? cacheMode)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
CacheMode?	cacheMode

Returns

Type	Description
IDisplayRequestBuilder

WithMediaTypeFromFilename(IDisplayRequestBuilder, string, string)

Declaration

public static IDisplayRequestBuilder WithMediaTypeFromFilename(this IDisplayRequestBuilder builder, string path, string mainType = null)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	path
string	mainType

Returns

Type	Description
IDisplayRequestBuilder

WithMediaTypeFromUrlPath(IDisplayRequestBuilder)

Declaration

public static IDisplayRequestBuilder WithMediaTypeFromUrlPath(this IDisplayRequestBuilder builder)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder

Returns

Type	Description
IDisplayRequestBuilder

WithOption(IDisplayRequestBuilder, string, object)

Declaration

public static IDisplayRequestBuilder WithOption(this IDisplayRequestBuilder builder, string name, object value)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	name
object	value

Returns

Type	Description
IDisplayRequestBuilder

WithOptions(IDisplayRequestBuilder, IDictionary<string, object>)

Declaration

public static IDisplayRequestBuilder WithOptions(this IDisplayRequestBuilder builder, IDictionary<string, object> options)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
IDictionary<string, object>	options

Returns

Type	Description
IDisplayRequestBuilder

WithPresets(IDisplayRequestBuilder, IEnumerable<string>)

Declaration

public static IDisplayRequestBuilder WithPresets(this IDisplayRequestBuilder builder, IEnumerable<string> presetIds)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
IEnumerable<string>	presetIds

Returns

Type	Description
IDisplayRequestBuilder

WithPresets(IDisplayRequestBuilder, params string[])

Declaration

public static IDisplayRequestBuilder WithPresets(this IDisplayRequestBuilder builder, params string[] presetIds)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string[]	presetIds

Returns

Type	Description
IDisplayRequestBuilder

WithRenderer(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder WithRenderer(this IDisplayRequestBuilder builder, string renderer)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	renderer

Returns

Type	Description
IDisplayRequestBuilder

WithTransformation(IDisplayRequestBuilder, string)

Declaration

public static IDisplayRequestBuilder WithTransformation(this IDisplayRequestBuilder builder, string transformation)

Parameters

Type	Name	Description
IDisplayRequestBuilder	builder
string	transformation

Returns

Type	Description
IDisplayRequestBuilder