OpenXchangeClient.Api.Halo (open_xchange_client v0.10.0)
API calls for all endpoints tagged Halo
.
Link to this section Summary
Functions
Gets a contact picture.
Gets all halo services.
Investigates a contact.
Investigates a contact.
Link to this section Functions
Link to this function
get_halo_contact_picture(connection, opts \\ [])
@spec get_halo_contact_picture( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, String.t()} | {:error, Tesla.Env.t()}
Gets a contact picture.
Important:
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :session (String.t): Falls back to the public session cookie.
- :internal_userid (integer()): The internal user ID of a user whose picture you want to load.
- :userid (integer()): An alias for
internal_userid
. - :user_id (integer()): An alias for
internal_userid
. - :id (String.t): A contact ID.
- :email (String.t): An email to searchz for. Will pick global address book matches before regular matches. After that picks the most recently changed contact.
- :email1 (String.t): An alias for
email
. - :email2 (String.t): An alias for
email
. - :email3 (String.t): An alias for
email
. - :transformation_needed (boolean()): Indicate if the image needs to be transformed.
- :crop_width (integer()): The width a cropped image should have. Needs to be a bigger value than the images width.
- :crop_height (integer()): The height a cropped image should have. Needs to be a bigger value than the images hight.
- :rotate (boolean()): Indicate if the image should get rotated
- :compress (boolean()): Indicate if the image should be compressed. Output format depends on scaleType.
- :width (integer()): The maximum width of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxWidth'. Default is 4096.
- :height (integer()): The maximum height of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxHeight'. Default is 4096.
- :shrink_only (boolean()): Set to 'true' to only scale images 'greater than' target size
- :scale_type (String.t): The scale type to use.
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
get_halo_services(connection, session, opts \\ [])
@spec get_halo_services(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.HaloServicesResponse.t()} | {:error, Tesla.Env.t()}
Gets all halo services.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
investigate_contact_halo(connection, session, provider, columns, opts \\ [])
@spec investigate_contact_halo( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.HaloInvestigationResponse.t()} | {:error, Tesla.Env.t()}
Investigates a contact.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- provider (String.t): The halo provider, like "com.openexchange.halo.contacts". See /halo/contact?action=services for available providers.
- columns (String.t): A comma-separated list of columns to return. See Column identifiers for a mapping of numeric identifiers to fields.
- opts (KeywordList): [optional] Optional parameters
- :email1 (String.t): The first eMail address of the contact
- :email2 (String.t): The second eMail address of the contact
- :email3 (String.t): The third eMail address of the contact
- :internal_userid (integer()): The internal id of the user
- :timezone (String.t): The timezone.
- :start (integer()): The start point. Only mandatory for provider "com.openexchange.halo.appointments".
- :end (integer()): The end point. Only mandatory for provider "com.openexchange.halo.appointments".
- :sort (String.t): The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. Optional for provider "com.openexchange.halo.appointments".
- :order (String.t): "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Optional for provider "com.openexchange.halo.appointments".
- :limit (integer()): The maximum number of mails within the result. Optional for provider "com.openexchange.halo.mail".
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
investigate_contact_halo_with_body(connection, session, provider, columns, opts \\ [])
@spec investigate_contact_halo_with_body( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.HaloInvestigationResponse.t()} | {:error, Tesla.Env.t()}
Investigates a contact.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- provider (String.t): The halo provider, like "com.openexchange.halo.contacts". See /halo/contact?action=services for available providers.
- columns (String.t): A comma-separated list of columns to return. See Column identifiers for a mapping of numeric identifiers to fields.
- opts (KeywordList): [optional] Optional parameters
- :timezone (String.t): The timezone.
- :start (integer()): The start point. Only mandatory for provider "com.openexchange.halo.appointments".
- :end (integer()): The end point. Only mandatory for provider "com.openexchange.halo.appointments".
- :sort (String.t): The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. Optional for provider "com.openexchange.halo.appointments".
- :order (String.t): "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Optional for provider "com.openexchange.halo.appointments".
- :limit (integer()): The maximum number of mails within the result. Optional for provider "com.openexchange.halo.mail".
- :contact_id (integer()): The id of the contact
- :internal_userid (integer()): The internal user id
- :uid (String.t): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- :display_name (String.t): The display name.
- :first_name (String.t): The given name.
- :last_name (String.t): The sur name.
- :second_name (String.t): The middle name.
- :suffix (String.t): The suffix.
- :title (String.t): The title.
- :street_home (String.t): The street of the home address.
- :postal_code_home (String.t): The postal code of the home address.
- :city_home (String.t): The city of the home address.
- :state_home (String.t): The state of the home address.
- :country_home (String.t): The country of the home address.
- :birthday (integer()): The date of birth.
- :marital_status (String.t): The marital status.
- :number_of_children (String.t): The number of children.
- :profession (String.t): The profession.
- :nickname (String.t): The nickname.
- :spouse_name (String.t): The name of the spouse.
- :anniversary (integer()): The anniversary.
- :note (String.t): A note.
- :department (String.t): The department.
- :position (String.t): The position.
- :employee_type (String.t): The type of the employee.
- :room_number (String.t): The room number.
- :street_business (String.t): The street of the business address.
- :postal_code_business (String.t): The postal code of the business address.
- :city_business (String.t): The city of the business address.
- :state_business (String.t): The state of the business address.
- :country_business (String.t): The country of the business address.
- :user_id (integer()): The internal user id.
- :number_of_employees (String.t): The number of employees.
- :sales_volume (String.t): The sales volume.
- :tax_id (String.t): The tax id.
- :commercial_register (String.t): The commercial register.
- :branches (String.t): The branches.
- :business_category (String.t): The business category.
- :info (String.t): An information.
- :manager_name (String.t): The manager's name.
- :assistant_name (String.t): The assistant's name.
- :street_other (String.t): The street of another address.
- :postal_code_other (String.t): The postal code of another address.
- :city_other (String.t): The city of another address.
- :state_other (String.t): The state of another address.
- :country_other (String.t): The country of another address.
- :telephone_business1 (String.t): The business telephone number 1.
- :telephone_business2 (String.t): The business telephone number 2.
- :fax_business (String.t): The business fax number.
- :telephone_callback (String.t): The callback telephone number.
- :telephone_car (String.t): The car telephone number.
- :telephone_company (String.t): The company telephone number.
- :telephone_home1 (String.t): The home telephone number 1.
- :telephone_home2 (String.t): The home telephone number 2.
- :fax_home (String.t): The home fax number.
- :cellular_telephone1 (String.t): The cellular telephone number 1.
- :cellular_telephone2 (String.t): The cellular telephone number 2.
- :telephone_other (String.t): The other telephone number.
- :fax_other (String.t): The other fax number.
- :email1 (String.t): The email address 1.
- :email2 (String.t): The email address 2.
- :email3 (String.t): The email address 3.
- :url (String.t): The url address or homepage.
- :telephone_isdn (String.t): The ISDN telephone number.
- :telephone_pager (String.t): The pager telephone number.
- :telephone_primary (String.t): The primary telephone number.
- :telephone_radio (String.t): The radio telephone number.
- :telephone_telex (String.t): The telex telephone number.
- :telephone_ttytdd (String.t): The TTY/TDD telephone number.
- :instant_messenger1 (String.t): The instant messenger address 1.
- :instant_messenger2 (String.t): The instant messenger address 2.
- :telephone_ip (String.t): The IP telephone number.
- :telephone_assistant (String.t): The assistant telephone number.
- :company (String.t): The company name.
- :image1 (String.t):
- :image1_content_type (String.t): The content type of the image (like \"image/png\").
- :image1_url (String.t): The url to the image.
- :number_of_images (integer()): The number of images.
- :image_last_modified (integer()): The last modification of the image.
- :distribution_list ([OpenXchangeClient.Model.DistributionListMember.t]): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- :number_of_distribution_list (integer()): The number of objects in the distribution list.
- :mark_as_distributionlist (boolean()):
- :file_as (String.t): The file name.
- :default_address (integer()): The default address.
- :use_count (integer()): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- :yomi_first_name (String.t): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- :yomi_last_name (String.t): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- :yomi_company (String.t): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- :address_home (String.t): Support for Outlook 'home' address field.
- :address_business (String.t): Support for Outlook 'business' address field.
- :address_other (String.t): Support for Outlook 'other' address field.
- :userfield01 (String.t): Dynamic Field 1.
- :userfield02 (String.t): Dynamic Field 2.
- :userfield03 (String.t): Dynamic Field 3.
- :userfield04 (String.t): Dynamic Field 4.
- :userfield05 (String.t): Dynamic Field 5.
- :userfield06 (String.t): Dynamic Field 6.
- :userfield07 (String.t): Dynamic Field 7.
- :userfield08 (String.t): Dynamic Field 8.
- :userfield09 (String.t): Dynamic Field 9.
- :userfield10 (String.t): Dynamic Field 10.
- :userfield11 (String.t): Dynamic Field 11.
- :userfield12 (String.t): Dynamic Field 12.
- :userfield13 (String.t): Dynamic Field 13.
- :userfield14 (String.t): Dynamic Field 14.
- :userfield15 (String.t): Dynamic Field 15.
- :userfield16 (String.t): Dynamic Field 16.
- :userfield17 (String.t): Dynamic Field 17.
- :userfield18 (String.t): Dynamic Field 18.
- :userfield19 (String.t): Dynamic Field 19.
- :userfield20 (String.t): Dynamic Field 20.
- :id (String.t): Object ID.
- :created_by (String.t): User ID of the user who created this object.
- :modified_by (String.t): User ID of the user who last modified this object.
- :creation_date (integer()): Date and time of creation.
- :last_modified (integer()): Date and time of the last modification.
- :folder_id (String.t): Object ID of the parent folder.
- :categories (String.t): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- :private_flag (boolean()): Overrides folder permissions in shared private folders: When
true
, this object is not visible to anyone except the owner. Not present in folder objects. - :color_label (integer()): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- :number_of_attachments (integer()): Number of attachments.
- :last_modified_of_newest_attachment_utc (integer()): Timestamp of the newest attachment written with UTC time zone.
returns
Returns
on success {:error, Tesla.Env.t} on failure