Class google.gdata.acl.AclScope

Object
   |
   +--google.gdata.acl.AclScope

class google.gdata.acl.AclScope

Describes the scope of an entry in an access control list.
Defined in gdata.js

Field Detail

type

{string|undefined} type

Type. This attribute is required.

value

{string|undefined} value

Value. This attribute is optional.

TYPE_DEFAULT

<static> <final> {string} TYPE_DEFAULT

Default scope.

See Also:

Constant Field Values

TYPE_DOMAIN

<static> <final> {string} TYPE_DOMAIN

Domain scope.

See Also:

Constant Field Values

TYPE_USER

<static> <final> {string} TYPE_USER

User scope.

See Also:

Constant Field Values

google.gdata.acl.AclScope

google.gdata.acl.AclScope(<Object> opt_params)

Constructs a scope using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: type and value.

getType

string|undefined getType()

Returns the type. This attribute is required.

Returns:
Type or undefined for none.

getValue

string|undefined getValue()

Returns the value. This attribute is optional.

Returns:
Value or undefined for none.

setType

void setType(<string|undefined> type)

Sets the type. This attribute is required.

Parameters:
type - Type or undefined for none.

setValue

void setValue(<string|undefined> value)

Sets the value. This attribute is optional.

Parameters:
value - Value or undefined for none.

create

<static> google.gdata.acl.AclScope create(<string?> value)

Create a new scope using the typical parameters.

Parameters:
value - Value or null for the default domain.

Returns:
new scope.