Titanium.Blob
> Titanium.Blob

A container for binary data.

A Blob represents a chunk of binary information, often obtained through an HTTPClient or by reading a File.

Blobs are often used to store text or image data. The Blob object includes a number of properties and methods specific to image blobs.

Android supports an append method, but otherwise blobs are immutable.

The Titanium.Utils module provides several utility methods for working with blobs, including methods for converting between blobs and Base64-encoded strings, and methods for generating SHA-1 and SHA-256 hashes and MD5 digests from blob data.

The Buffer object can also contain binary data, and is more easily mutable. Extracting blob data to a buffer is somewhat roundabout:

var blobStream = Ti.Stream.createStream({ source: myBlob, mode: Ti.Stream.MODE_READ });
var newBuffer = Ti.createBuffer({ length: myBlob.length });
var bytes = blobStream.read(newBuffer);

Creating a blob from a buffer is much easier:

var newBlob = myBuffer.toBlob();

In both cases, the conversion involves copying the data from one object to another, so you should be conscious of the amount of the data being copied.

  • 0.9
  • 0.9
  • 0.9
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Blob
file : Titanium.Filesystem.Filereadonly

File object represented by this blob, or null if this blob is not associated with a file.

File object represented by this blob, or null if this blob is not associated with a file.

Titanium.Blob
height : Numberreadonly

If this blob represents an image, this is the height of the image in pixels.

If this blob represents an image, this is the height of the image in pixels.

If this blob doesn't represent an image, height is 0.

Titanium.Blob
length : Numberreadonly

Length of this blob in bytes.

Length of this blob in bytes.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Titanium.Blob
mimeType : Stringreadonly

Mime type of the data in this blob.

Mime type of the data in this blob.

Titanium.Blob
nativePath : Stringreadonly

If this blob represents a File, this is the file URL that represents it.

If this blob represents a File, this is the file URL that represents it.

If this blob doesn't represent a file, the value of nativePath is null.

Titanium.Blob
size : Numberreadonly

Size of the blob in pixels (for image blobs) or bytes (for all other blobs).

Size of the blob in pixels (for image blobs) or bytes (for all other blobs).

If this blob represents an image, this is the total number of pixels in the image. Otherwise it returns the number of bytes in the binary data.

  • 0.9
  • 0.9
Titanium.Blob
text : Stringreadonly

UTF-8 string representation of the data in this blob.

UTF-8 string representation of the data in this blob.

If this blob represents pure binary data, the value will be null.

Titanium.Blob
width : Numberreadonly

If this blob represents an image, this is the width of the image in pixels.

If this blob represents an image, this is the width of the image in pixels.

If this blob doesn't represent an image, height is 0.

Defined By

Methods

Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Titanium.Blob
( blob )
Appends the data from another blob to this blob. ...

Appends the data from another blob to this blob.

  • 0.9

Parameters

Returns

  • void
Applies the properties to the proxy. ...

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • name : String

    Name of the event.

  • event : Dictionary

    A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the file property. ...

Gets the value of the file property.

Returns

Titanium.Blob
( ) : Number
Gets the value of the height property. ...

Gets the value of the height property.

Returns

  • Number
Titanium.Blob
( ) : Number
Gets the value of the length property. ...

Gets the value of the length property.

Returns

  • Number
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Blob
( ) : String
Gets the value of the mimeType property. ...

Gets the value of the mimeType property.

Returns

  • String
Titanium.Blob
( ) : String
Gets the value of the nativePath property. ...

Gets the value of the nativePath property.

Returns

  • String
Titanium.Blob
( ) : Number
Gets the value of the size property. ...

Gets the value of the size property.

  • 0.9
  • 0.9

Returns

  • Number
Titanium.Blob
( ) : String
Gets the value of the text property. ...

Gets the value of the text property.

Returns

  • String
Titanium.Blob
( ) : Number
Gets the value of the width property. ...

Gets the value of the width property.

Returns

  • Number
Titanium.Blob
( quality ) : Titanium.Blob
Creates a new blob by compressing the underlying image to the specified quality. ...

Creates a new blob by compressing the underlying image to the specified quality.

Returns the compressed image as a blob.

If this blob doesn't represent an image, returns null.

  • 6.1.0
  • 6.1.0
  • 6.1.0

Parameters

  • quality : Number

    Quality to compress this image to. From 0.0 (lowest quality) to 1.0 (highest quality).

Returns

Titanium.Blob
( options ) : Titanium.Blob
Creates a new blob by cropping the underlying image to the specified dimensions. ...

Creates a new blob by cropping the underlying image to the specified dimensions.

Returns the cropped image as a blob.

If this blob doesn't represent an image, returns null.

  • 3.0.0
  • 0.9
  • 0.9

Parameters

Returns

Titanium.Blob
( width, height ) : Titanium.Blob
Creates a new blob by resizing and scaling the underlying image to the specified dimensions. ...

Creates a new blob by resizing and scaling the underlying image to the specified dimensions.

Returns the resized image as a blob.

If this blob doesn't represent an image, returns null.

  • 3.0.0
  • 0.9
  • 0.9

Parameters

  • width : Number

    Width to resize this image to.

  • height : Number

    Height to resize this image to.

Returns

Titanium.Blob
( size, [borderSize], [cornerRadius] ) : Titanium.Blob
Returns a thumbnail version of the underlying image, optionally with a border and rounded corners. ...

Returns a thumbnail version of the underlying image, optionally with a border and rounded corners.

Returns the thumbnail image as a blob.

If this blob doesn't represent an image, returns null.

  • 3.0.0
  • 0.9
  • 0.9

Parameters

  • size : Number

    Size of the thumbnail, in either width or height.

  • borderSize : Number (optional)

    Width of the thumbnail's border.

  • cornerRadius : Number (optional)

    Radius of the thumbnail's corners.

Returns

Titanium.Blob
( ) : Titanium.Blob
Returns a copy of the underlying image with an added alpha channel. ...

Returns a copy of the underlying image with an added alpha channel.

Returns the new image as a blob, or null if this blob is not an image.

  • 3.0.0
  • 0.9
  • 0.9

Returns

  • Titanium.Blob

    The image with an alpha channel in a blob, or null if this blob is not an image.

Titanium.Blob
( cornerSize, [borderSize] ) : Titanium.Blob
Returns a copy of the underlying image with rounded corners added. ...

Returns a copy of the underlying image with rounded corners added.

Returns the new image as a blob, or null if this blob is not an image.

  • 3.0.0
  • 0.9
  • 0.9

Parameters

  • cornerSize : Number

    Size of the rounded corners in pixels.

  • borderSize : Number (optional)

    Width of the border in pixels.

Returns

  • Titanium.Blob

    Image with a rounded corner in a blob, or null if this blob is not an image.

Returns a copy of the underlying image with an added transparent border. ...

Returns a copy of the underlying image with an added transparent border.

Returns the new image as a blob, or null if this blob is not an image.

  • 3.0.0
  • 0.9
  • 0.9

Parameters

  • size : Number

    Width of the transparent border in pixels.

Returns

  • Titanium.Blob

    The image with a transparent border in a blob, or null if this blob is not an image.

Removes the specified callback as an event listener for the named event. ...

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.Blob
( ) : String
Returns a string representation of this blob. ...

Returns a string representation of this blob.

Returns

  • String