Help Center

Local Navigation

Object: Plugin

Availability

BlackBerry® Device Software version 4.6 or later

The Plugin object represents an installed plugin.

You can access an individual Plugin within a collection by its index position using Plugin.item(), by its name or id attribute using Plugin.namedItem(), or you can index the object directly. For example, if you create an instance of a Plugin object called myPlugins, then specifying

myPlugins.item(2)

myPlugins.namedItem(“item”)

is equivalent to specifying

myPlugins[2]

myPlugins[“item”]

Plugin properties

Property name

Type

Description

Status

Availability

description

String

Returns the description of the Plugin.

read only

4.6 or later

filename

String

Returns the Plugin filename.

read only

4.6 or later

length

unsigned long

Returns the number of MIME types associated with the Plugin.

read only

4.6 or later

name

String

Returns the name of the Plugin.

read only

4.6 or later

Plugin methods

Method name

Description

Availability

item()

Returns the Plugin at the specified index in the collection.

4.6 or later

namedItem()

Returns the Plugin with the given name.

4.6 or later

Method: Plugin.item()

Availability

BlackBerry® Device Software version 4.6 or later

The item() method returns the Plugin at the specified index in the collection.

Syntax

Plugin.item( index )

Parameters

Parameter

Type

Description

index

int

The index position of the Plugin to be returned. Valid values are between 0 and Plugin.length-1 inclusive.

Return values

Returns the plugin at the indexth position in Plugin, or null if an invalid index position is specified.

Exceptions

None.

Method: Plugin.namedItem()

Availability

BlackBerry® Device Software version 4.6 or later

The namedItem() method retrieves the Plugin with the given name from the collection.

Syntax

Plugin.namedItem( name )

Parameters

Parameter

Type

Description

name

String

The name of the Plugin to retrieve.

Return values

Returns the Plugin with the given name, or null if no Plugin with the given name exists in the array.

Exceptions

None.


Was this information helpful? Send us your comments.