Intercom (intercom-java 0.0.4 API)

java.lang.Object
- com.github.oohira.intercom.Intercom

```
public class Intercom
extends Object
```
Class wrapping Intercom APIs.

作成者:

oohira

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`Intercom()` Create an Intercom object without App ID and API key.
`Intercom(String appId, String apiKey)` Create an Intercom object with App ID and API key.

メソッドのサマリー

メソッド
修飾子とタイプ	メソッドと説明
`Impression`	`createImpression(Impression impression)` Creates an impression.
`Note`	`createNote(Note note)` Creates a new note.
`Tag`	`createTag(Tag tag)` Creates a new tag, optionally, tag/untag users.
`User`	`createUser(User user)` Creates a user.
`User`	`deleteUserByEmail(String email)` Deletes a user.
`User`	`deleteUserById(String userId)` Deletes a user.
`<T> T`	`deserialize(String json, Class<T> clazz)`
`String`	`getApiKey()` Get an API key.
`String`	`getAppId()` Get an App ID.
`Company`	`getCompanyById(String companyId)` Retrieves a company.
`Tag`	`getTag(String name)` Retrieves a tag.
`User`	`getUserByEmail(String email)` Retrieves a user.
`User`	`getUserById(String userId)` Retrieves a user.
`int`	`getUserCount()` Retrieves total count of users.
`UserIterator`	`getUsers()` Retrieves all users.
`UserIterator`	`getUsersByTagName(String tagName)` Retrieves all users.
`<T> String`	`serialize(T object)`
`void`	`setApiKey(String apiKey)` Set an API key.
`void`	`setAppId(String appId)` Set an App ID.
`void`	`trackEvent(Event event)` Tracks an event.
`Tag`	`updateTag(Tag tag)` Updates an already existing tag.
`User`	`updateUser(User user)` Updates an already existing user.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - Intercom
```
public Intercom()
```
    Create an Intercom object without App ID and API key. App ID, API key must be set by setAppId(String) and setApiKey(String).
  - Intercom
```
public Intercom(String appId,
        String apiKey)
```
    Create an Intercom object with App ID and API key.
    
    パラメータ:
    appId - App ID.
    apiKey - API key.
    関連項目:
    Intercom API Document: Authentication
- メソッドの詳細
  - serialize
```
public <T> String serialize(T object)
```
  - deserialize
```
public <T> T deserialize(String json,
                Class<T> clazz)
              throws IntercomException
```
    例外:
    
    IntercomException
  - setAppId
```
public void setAppId(String appId)
```
    Set an App ID.
    
    パラメータ:
    appId - App ID.
  - getAppId
```
public String getAppId()
```
    Get an App ID.
    
    戻り値:
    App ID (may be null).
  - setApiKey
```
public void setApiKey(String apiKey)
```
    Set an API key.
    
    パラメータ:
    apiKey - API key (may be null).
  - getApiKey
```
public String getApiKey()
```
    Get an API key.
    
    戻り値:
    API key (may be null).
  - getUsers
```
public UserIterator getUsers()
```
    Retrieves all users. NOTE: The order of users is not defined.
    
    戻り値:
    iterator for all users.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Getting all Users
  - getUsersByTagName
```
public UserIterator getUsersByTagName(String tagName)
```
    Retrieves all users. NOTE: The order of users is not defined.
    
    パラメータ:
    tagName - tag name.
    
    戻り値:
    iterator for users attached specified tag.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Getting all Users
  - getUserCount
```
public int getUserCount()
                 throws IntercomException
```
    Retrieves total count of users.
    
    戻り値:
    total count of users.
    
    例外:
    
    IntercomException - when some error occurred.
  - getUserById
```
public User getUserById(String userId)
                 throws IntercomException
```
    Retrieves a user.
    
    パラメータ:
    userId - an unique identifier for the user.
    
    戻り値:
    the retrieved user.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Getting a User
  - getUserByEmail
```
public User getUserByEmail(String email)
                    throws IntercomException
```
    Retrieves a user.
    
    パラメータ:
    email - an email address.
    
    戻り値:
    the retrieved user.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Getting a User
  - createUser
```
public User createUser(User user)
                throws IntercomException
```
    Creates a user.
    
    パラメータ:
    user - a new user object.
    
    戻り値:
    the created user object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Creating a User
  - updateUser
```
public User updateUser(User user)
                throws IntercomException
```
    Updates an already existing user.
    
    パラメータ:
    user - a user object.
    
    戻り値:
    the updated user object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Updating a User
  - deleteUserById
```
public User deleteUserById(String userId)
                    throws IntercomException
```
    Deletes a user.
    
    パラメータ:
    userId - an unique identifier for the user.
    
    戻り値:
    the deleted user.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Deleting a User
  - deleteUserByEmail
```
public User deleteUserByEmail(String email)
                       throws IntercomException
```
    Deletes a user.
    
    パラメータ:
    email - an email address.
    
    戻り値:
    the deleted user.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Document: Deleting a User
  - getCompanyById
```
public Company getCompanyById(String companyId)
                       throws IntercomException
```
    Retrieves a company. NOTE: This company retrieval API is not documented in official.
    
    パラメータ:
    companyId - an unique identifier for the company.
    
    戻り値:
    the retrieved company.
    
    例外:
    
    IntercomException - when some error occurred.
  - getTag
```
public Tag getTag(String name)
           throws IntercomException
```
    Retrieves a tag.
    
    パラメータ:
    name - the name of the tag.
    
    戻り値:
    the tag object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Documentation: Getting a Tag
  - createTag
```
public Tag createTag(Tag tag)
              throws IntercomException
```
    Creates a new tag, optionally, tag/untag users.
    
    パラメータ:
    tag - a new tag object.
    
    戻り値:
    the created tag object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Documentation: Creating a Tag
  - updateTag
```
public Tag updateTag(Tag tag)
              throws IntercomException
```
    Updates an already existing tag.
    
    パラメータ:
    tag - a tag object.
    
    戻り値:
    the updated tag object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Documentation: Updating a Tag
  - createNote
```
public Note createNote(Note note)
                throws IntercomException
```
    Creates a new note.
    
    パラメータ:
    note - a new note object.
    
    戻り値:
    the created note object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Documentation: Creating a Note
  - createImpression
```
public Impression createImpression(Impression impression)
                            throws IntercomException
```
    Creates an impression.
    
    パラメータ:
    impression - an impression object.
    
    戻り値:
    the response object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Documentation: Creating an Impression
  - trackEvent
```
public void trackEvent(Event event)
                throws IntercomException
```
    Tracks an event.
    
    パラメータ:
    event - an event object.
    
    例外:
    
    IntercomException - when some error occurred.
    関連項目:
    Intercom API Documentation: Submitting Events

クラス Intercom

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

Intercom

Intercom

メソッドの詳細

serialize

deserialize

setAppId

getAppId

setApiKey

getApiKey

getUsers

getUsersByTagName

getUserCount

getUserById

getUserByEmail

createUser

updateUser

deleteUserById

deleteUserByEmail

getCompanyById

getTag

createTag

updateTag

createNote

createImpression

trackEvent