Conforms to NSObject
Declared in Buddy.h

Overview

See SFSBuddy

Tasks

  • – id

    The id of the Buddy

         required method
  • – name

    The name of the Buddy

         required method
  • – isBlocked

    Returns true if the Buddy is blocked in the current Users' BuddyList

         required method
  • – isOnline

    Return true if the User is online in the BuddyList system The value is stored in a reserved Buddy Variable

         required method
  • – isTemp

    Return true if the Buddy is temporary (not persistent)

         required method
  • – state

    The current Buddy custom state (e.g. “Available”, “Busy”, etc…)

         required method
  • – nickName

    An optional Buddy nickname

         required method
  • – variables

    Obtain a list of BuddyVariables.

         required method
  • – getVariable:

    Get the BuddyVariable with the provided name.

         required method
  • – containsVariable:

    Return true if a BuddyVariable with the provided name exists

         required method
  • – getOfflineVariables

    Return a list of offline Buddy Variables

         required method
  • – getOnlineVariables

    Return a list of non-persistent Buddy Variables

         required method

Instance Methods

containsVariable:

Return true if a BuddyVariable with the provided name exists

- (BOOL)containsVariable:(NSString *)varName

Discussion

Return true if a BuddyVariable with the provided name exists

Declared In

Buddy.h

getOfflineVariables

Return a list of offline Buddy Variables

- (NSArray *)getOfflineVariables

Discussion

Return a list of offline Buddy Variables

Declared In

Buddy.h

getOnlineVariables

Return a list of non-persistent Buddy Variables

- (NSArray *)getOnlineVariables

Discussion

Return a list of non-persistent Buddy Variables

Declared In

Buddy.h

getVariable:

Get the BuddyVariable with the provided name.

- (id<BuddyVariable>)getVariable:(NSString *)varName

Discussion

Get the BuddyVariable with the provided name.

nil is returned if not BuddyVariable exists with that name

Declared In

Buddy.h

id

The id of the Buddy

- (NSInteger)id

Discussion

The id of the Buddy

The id corresponds to the current id of the User in the system

Declared In

Buddy.h

isBlocked

Returns true if the Buddy is blocked in the current Users' BuddyList

- (BOOL)isBlocked

Discussion

Returns true if the Buddy is blocked in the current Users' BuddyList

See Also

Declared In

Buddy.h

isOnline

Return true if the User is online in the BuddyList system The value is stored in a reserved Buddy Variable

- (BOOL)isOnline

Discussion

Return true if the User is online in the BuddyList system The value is stored in a reserved Buddy Variable

See Also

Declared In

Buddy.h

isTemp

Return true if the Buddy is temporary (not persistent)

- (BOOL)isTemp

Discussion

Return true if the Buddy is temporary (not persistent)

Declared In

Buddy.h

name

The name of the Buddy

- (NSString *)name

Discussion

The name of the Buddy

Declared In

Buddy.h

nickName

An optional Buddy nickname

- (NSString *)nickName

Discussion

An optional Buddy nickname

The value is stored in a reserved Buddy Variable

See Also

Declared In

Buddy.h

state

The current Buddy custom state (e.g. “Available”, “Busy”, etc…)

- (NSString *)state

Discussion

The current Buddy custom state (e.g. “Available”, “Busy”, etc…)

The value is stored in a reserved Buddy Variable

See Also

Declared In

Buddy.h

variables

Obtain a list of BuddyVariables.

- (NSArray *)variables

Discussion

Obtain a list of BuddyVariables.

Please note that by convention any variable whose name starts with the dollar sign ($) will be regarded as persistent and stored locally by the server.

These variables are also referred to as “offline variables” because they are available to other Users even when the Buddy is offline.

See Also

Declared In

Buddy.h