com.sendbird.android

Class OGImage

java.lang.Object

com.sendbird.android.OGImage

public class OGImage
extends java.lang.Object

Represents a OGImage of OGMetaData. For Specifications, see https://ogp.me/.

Since:

3.0.139

See Also:

https://ogp.me/

Method Summary

Modifier and Type	Method and Description
static OGImage	buildFromSerializedData(byte[] data) Builds OGImage instance from serialized data generated by serialize().
boolean	equals(java.lang.Object obj)
java.lang.String	getAlt() A description of what is in the image (not a caption).
int	getHeight() The number of pixels high.
java.lang.String	getSecureUrl() An alternate url to use if the webpage requires HTTPS.
java.lang.String	getType() A MIME type for this image.
java.lang.String	getUrl() An image URL which represents the object within the Open Graph.
int	getWidth() The number of pixels wide.
int	hashCode()
byte[]	serialize() Serializes the OGImage instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getUrl

public java.lang.String getUrl()

An image URL which represents the object within the Open Graph.

Returns:

url to the image. Nullable. ex: "http://example.com/ogp.jpg"

Since:

3.0.139

See Also:

https://ogp.me/

getSecureUrl

public java.lang.String getSecureUrl()

An alternate url to use if the webpage requires HTTPS.

Returns:

secure url to the image. Nullable. ex: "https://secure.example.com/ogp.jpg"

Since:

3.0.139

See Also:

https://ogp.me/

getType

public java.lang.String getType()

A MIME type for this image.

Returns:

type of the image. Nullable. ex: "image/jpeg"

Since:

3.0.139

See Also:

https://ogp.me/, https://en.wikipedia.org/wiki/Media_type

getWidth

public int getWidth()

The number of pixels wide.

Returns:

width. ex: 400

Since:

3.0.139

See Also:

https://ogp.me/

getHeight

public int getHeight()

The number of pixels high.

Returns:

height. ex: 300

Since:

3.0.139

See Also:

https://ogp.me/

getAlt

public java.lang.String getAlt()

A description of what is in the image (not a caption).

Returns:

alt string. Nullable. ex: "A shiny red apple with a bite taken out"

Since:

3.0.139

See Also:

https://ogp.me/

buildFromSerializedData

public static OGImage buildFromSerializedData(byte[] data)

Builds OGImage instance from serialized data generated by serialize().

Parameters:

data - Serialized OGImage data.

Returns:

OGImage instance.

Since:

3.0.139

serialize

public byte[] serialize()

Serializes the OGImage instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData(byte[]).

Returns:

Serialized OGImage data.

Since:

3.0.139

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object