C# Class TrakHound.API.Devices

Show file Open project: TrakHound/TrakHound-Community

Public Methods

Method Description
Check ( UserConfiguration userConfig, string deviceUniqueId ) : CheckInfo

Check the status (Update Id) of a single Device

Check ( UserConfiguration userConfig ) : List

Check the status (Update Id) for a list of devices

Get ( UserConfiguration userConfig, string deviceUniqueId ) : DeviceConfiguration

Get a single DeviceConfiguration

Get ( UserConfiguration userConfig ) : List

Get a list of DeviceConfigurations of all of the user's devices

Get ( UserConfiguration userConfig, string deviceUniqueIds ) : List
List ( UserConfiguration userConfig, string deviceUniqueId, Uri apiHost ) : DeviceDescription

List a single DeviceDescription

List ( UserConfiguration userConfig, Uri apiHost ) : List

Get a list of DeviceDescriptions of all of the user's devices

List ( UserConfiguration userConfig, string deviceUniqueIds, Uri apiHost ) : List
Remove ( UserConfiguration userConfig ) : bool

Remove all of the user's devices

Remove ( UserConfiguration userConfig, string deviceUniqueIds ) : bool

Remove Specified Devices from User

Update ( UserConfiguration userConfig, DataTable table ) : bool
Update ( UserConfiguration userConfig, DeviceConfiguration deviceConfig ) : bool
Update ( UserConfiguration userConfig, DeviceInfo deviceInfo ) : bool
Update ( UserConfiguration userConfig, List deviceInfos, bool replace = true ) : bool
Update ( UserConfiguration userConfig, string deviceUniqueId, DeviceInfo deviceRow ) : bool

Method Details

Check() public static method

Check the status (Update Id) of a single Device
public static Check ( UserConfiguration userConfig, string deviceUniqueId ) : CheckInfo
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
deviceUniqueId string The Unique ID of the device to return
return CheckInfo

Check() public static method

Check the status (Update Id) for a list of devices
public static Check ( UserConfiguration userConfig ) : List
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
return List

Get() public static method

Get a single DeviceConfiguration
public static Get ( UserConfiguration userConfig, string deviceUniqueId ) : DeviceConfiguration
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
deviceUniqueId string The Unique ID of the device to return
return DeviceConfiguration

Get() public static method

Get a list of DeviceConfigurations of all of the user's devices
public static Get ( UserConfiguration userConfig ) : List
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
return List

Get() public static method

public static Get ( UserConfiguration userConfig, string deviceUniqueIds ) : List
userConfig TrakHound.API.Users.UserConfiguration
deviceUniqueIds string
return List

List() public static method

List a single DeviceDescription
public static List ( UserConfiguration userConfig, string deviceUniqueId, Uri apiHost ) : DeviceDescription
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
deviceUniqueId string The Unique ID of the device to return
apiHost System.Uri
return DeviceDescription

List() public static method

Get a list of DeviceDescriptions of all of the user's devices
public static List ( UserConfiguration userConfig, Uri apiHost ) : List
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
apiHost System.Uri
return List

List() public static method

public static List ( UserConfiguration userConfig, string deviceUniqueIds, Uri apiHost ) : List
userConfig TrakHound.API.Users.UserConfiguration
deviceUniqueIds string
apiHost System.Uri
return List

Remove() public static method

Remove all of the user's devices
public static Remove ( UserConfiguration userConfig ) : bool
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
return bool

Remove() public static method

Remove Specified Devices from User
public static Remove ( UserConfiguration userConfig, string deviceUniqueIds ) : bool
userConfig TrakHound.API.Users.UserConfiguration UserConfiguration object for the current user
deviceUniqueIds string
return bool

Update() public static method

public static Update ( UserConfiguration userConfig, DataTable table ) : bool
userConfig TrakHound.API.Users.UserConfiguration
table DataTable
return bool

Update() public static method

public static Update ( UserConfiguration userConfig, DeviceConfiguration deviceConfig ) : bool
userConfig TrakHound.API.Users.UserConfiguration
deviceConfig DeviceConfiguration
return bool

Update() public static method

public static Update ( UserConfiguration userConfig, DeviceInfo deviceInfo ) : bool
userConfig TrakHound.API.Users.UserConfiguration
deviceInfo DeviceInfo
return bool

Update() public static method

public static Update ( UserConfiguration userConfig, List deviceInfos, bool replace = true ) : bool
userConfig TrakHound.API.Users.UserConfiguration
deviceInfos List
replace bool
return bool

Update() public static method

public static Update ( UserConfiguration userConfig, string deviceUniqueId, DeviceInfo deviceRow ) : bool
userConfig TrakHound.API.Users.UserConfiguration
deviceUniqueId string
deviceRow DeviceInfo
return bool