Emoticons

hipchatter.emoticons

Returns up to 100 emoticons.

HipChat API reference

Parameters:

• param (object) - Optional. query string parameters (optional)
  • 'start-index': <int> - Optional. The start index for the result set. Defaults to 0.
  • 'max-results': <int> - Optional. The maximum number of results. Defaults to 100.
  • 'type': <string> - Optional. The type of emoticons to get. Defaults to 'all'.
• param (int) - Optional. id for single emoticon.
• param (string) - Optional. shortcut for single emoticon.

Results: err, response (array: list of emoticons) (object: single emoticon)

Usage

// default: returns array of all emoticons
hipchatter.emoticons(function(err, emoticons){
    console.log(emoticons);
});

hipchatter.emoticons({'start-index': 20, 'max-results': 40, 'type': 'group'}, function(err, emoticons){
   console.log(emoticons); 
});

hipchatter.emoticons(34, function(err, emoticon){
    console.log(emoticon);
});

hipchatter.emoticons('fonzie', function(err, emoticon){
    console.log(emoticon);
});

hipchatter.get_emoticon

Get an emoticon by id or shortcut.

HipChat API reference

Parameters:

• param (int) - Required. id for single emoticon. or
• param (string) - Required. shortcut for single emoticon.

Results: err, response (object) - single emoticon details

Usage

hipchatter.get_emoticon(34, function(err, emoticon){
    console.log(emoticon);
});

hipchatter.get_emoticon('fonzie', function(err, emoticon){
    console.log(emoticon);
});
}