Package com.ringcentral.definitions

Class BackgroundImage

java.lang.Object

com.ringcentral.definitions.BackgroundImage

public class BackgroundImage
extends Object

Specifies a background image oa a card. Acceptable formats are PNG, JPEG, and GIF

Field Summary

Fields

Modifier and Type	Field	Description
String	fillMode	Describes how the image should fill the area Enum: cover, repeatHorizontally, repeatVertically, repeat
String	horizontalAlignment	Describes how the image should be aligned if it must be cropped or if using repeat fill mode Enum: left, center, right
String	type	Must be `BackgroundImage` Enum: BackgroundImage
String	url	The URL/data URL of an image to be used as a background of a card.
String	verticalAlignment	Describes how the image should be aligned if it must be cropped or if using repeat fill mode Enum: top, center, bottom

Constructor Summary

Constructors

Constructor	Description
BackgroundImage()

Method Summary

Modifier and Type	Method	Description
BackgroundImage	fillMode(String fillMode)
BackgroundImage	horizontalAlignment(String horizontalAlignment)
BackgroundImage	type(String type)
BackgroundImage	url(String url)
BackgroundImage	verticalAlignment(String verticalAlignment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

type

public String type

Must be `BackgroundImage` Enum: BackgroundImage

url

public String url

The URL/data URL of an image to be used as a background of a card. Acceptable formats are PNG, JPEG, and GIF Required Format: uri

fillMode

public String fillMode

Describes how the image should fill the area Enum: cover, repeatHorizontally, repeatVertically, repeat

horizontalAlignment

public String horizontalAlignment

Describes how the image should be aligned if it must be cropped or if using repeat fill mode Enum: left, center, right

verticalAlignment

public String verticalAlignment

Describes how the image should be aligned if it must be cropped or if using repeat fill mode Enum: top, center, bottom

Constructor Details

BackgroundImage

public BackgroundImage()

Method Details

type

public BackgroundImage type(String type)

url

public BackgroundImage url(String url)

fillMode

public BackgroundImage fillMode(String fillMode)

horizontalAlignment

public BackgroundImage horizontalAlignment(String horizontalAlignment)

verticalAlignment

public BackgroundImage verticalAlignment(String verticalAlignment)