Package com.microsoft.graph.models

Class BookingAppointment

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.BookingAppointment
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class BookingAppointment extends Entity implements com.microsoft.kiota.serialization.Parsable
Represents a booked appointment of a service by a customer in a business.

  • Constructor Details

    • BookingAppointment

      public BookingAppointment()
      Instantiates a new BookingAppointment and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static BookingAppointment createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a BookingAppointment

    • getAdditionalInformation

      @Nullable public String getAdditionalInformation()
      Gets the additionalInformation property value. Additional information that is sent to the customer when an appointment is confirmed.
      Returns:
      a String

    • getAnonymousJoinWebUrl

      @Nullable public String getAnonymousJoinWebUrl()
      Gets the anonymousJoinWebUrl property value. The URL of the meeting to join anonymously.
      Returns:
      a String

    • getAppointmentLabel

      @Nullable public String getAppointmentLabel()
      Gets the appointmentLabel property value. The custom label that can be stamped on this appointment by users.
      Returns:
      a String

    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. The date, time, and time zone when the appointment was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Returns:
      a OffsetDateTime

    • getCustomerEmailAddress

      @Nullable public String getCustomerEmailAddress()
      Gets the customerEmailAddress property value. The SMTP address of the bookingCustomer who books the appointment.
      Returns:
      a String

    • getCustomerName

      @Nullable public String getCustomerName()
      Gets the customerName property value. The customer's name.
      Returns:
      a String

    • getCustomerNotes

      @Nullable public String getCustomerNotes()
      Gets the customerNotes property value. Notes from the customer associated with this appointment. You can get the value only when you read this bookingAppointment by its ID. You can set this property only when you initially create an appointment with a new customer.
      Returns:
      a String

    • getCustomerPhone

      @Nullable public String getCustomerPhone()
      Gets the customerPhone property value. The customer's phone number.
      Returns:
      a String

    • getCustomers

      @Nullable public List<BookingCustomerInformationBase> getCustomers()
      Gets the customers property value. A collection of customer properties for an appointment. An appointment contains a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.
      Returns:
      a List<BookingCustomerInformationBase>

    • getCustomerTimeZone

      @Nullable public String getCustomerTimeZone()
      Gets the customerTimeZone property value. The time zone of the customer. For a list of possible values, see dateTimeTimeZone.
      Returns:
      a String

    • getDuration

      @Nullable public com.microsoft.kiota.PeriodAndDuration getDuration()
      Gets the duration property value. The length of the appointment, denoted in ISO8601 format.
      Returns:
      a PeriodAndDuration

    • getEndDateTime

      @Nullable public DateTimeTimeZone getEndDateTime()
      Gets the endDateTime property value. The endDateTime property
      Returns:
      a DateTimeTimeZone

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getFilledAttendeesCount

      @Nullable public Integer getFilledAttendeesCount()
      Gets the filledAttendeesCount property value. The current number of customers in the appointment.
      Returns:
      a Integer

    • getIsCustomerAllowedToManageBooking

      @Nullable public Boolean getIsCustomerAllowedToManageBooking()
      Gets the isCustomerAllowedToManageBooking property value. Indicates that the customer can manage bookings created by the staff. The default value is false.
      Returns:
      a Boolean

    • getIsLocationOnline

      @Nullable public Boolean getIsLocationOnline()
      Gets the isLocationOnline property value. Indicates that the appointment is held online. The default value is false.
      Returns:
      a Boolean

    • getJoinWebUrl

      @Nullable public String getJoinWebUrl()
      Gets the joinWebUrl property value. The URL of the online meeting for the appointment.
      Returns:
      a String

    • getLastUpdatedDateTime

      @Nullable public OffsetDateTime getLastUpdatedDateTime()
      Gets the lastUpdatedDateTime property value. The date, time, and time zone when the booking business was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Returns:
      a OffsetDateTime

    • getMaximumAttendeesCount

      @Nullable public Integer getMaximumAttendeesCount()
      Gets the maximumAttendeesCount property value. The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.
      Returns:
      a Integer

    • getOptOutOfCustomerEmail

      @Nullable public Boolean getOptOutOfCustomerEmail()
      Gets the optOutOfCustomerEmail property value. If true indicates that the bookingCustomer for this appointment doesn't wish to receive a confirmation for this appointment.
      Returns:
      a Boolean

    • getPostBuffer

      @Nullable public com.microsoft.kiota.PeriodAndDuration getPostBuffer()
      Gets the postBuffer property value. The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.
      Returns:
      a PeriodAndDuration

    • getPreBuffer

      @Nullable public com.microsoft.kiota.PeriodAndDuration getPreBuffer()
      Gets the preBuffer property value. The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.
      Returns:
      a PeriodAndDuration

    • getPrice

      @Nullable public Double getPrice()
      Gets the price property value. The regular price for an appointment for the specified bookingService.
      Returns:
      a Double

    • getPriceType

      @Nullable public BookingPriceType getPriceType()
      Gets the priceType property value. Represents the type of pricing of a booking service.
      Returns:
      a BookingPriceType

    • getReminders

      @Nullable public List<BookingReminder> getReminders()
      Gets the reminders property value. The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID.
      Returns:
      a List<BookingReminder>

    • getSelfServiceAppointmentId

      @Nullable public String getSelfServiceAppointmentId()
      Gets the selfServiceAppointmentId property value. Another tracking ID for the appointment, if the appointment was created directly by the customer on the scheduling page, as opposed to by a staff member on behalf of the customer.
      Returns:
      a String

    • getServiceId

      @Nullable public String getServiceId()
      Gets the serviceId property value. The ID of the bookingService associated with this appointment.
      Returns:
      a String

    • getServiceLocation

      @Nullable public Location getServiceLocation()
      Gets the serviceLocation property value. The location where the service is delivered.
      Returns:
      a Location

    • getServiceName

      @Nullable public String getServiceName()
      Gets the serviceName property value. The name of the bookingService associated with this appointment.This property is optional when creating a new appointment. If not specified, it's computed from the service associated with the appointment by the serviceId property.
      Returns:
      a String

    • getServiceNotes

      @Nullable public String getServiceNotes()
      Gets the serviceNotes property value. Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.
      Returns:
      a String

    • getSmsNotificationsEnabled

      @Nullable public Boolean getSmsNotificationsEnabled()
      Gets the smsNotificationsEnabled property value. If true, indicates SMS notifications will be sent to the customers for the appointment. Default value is false.
      Returns:
      a Boolean

    • getStaffMemberIds

      @Nullable public List<String> getStaffMemberIds()
      Gets the staffMemberIds property value. The ID of each bookingStaffMember who is scheduled in this appointment.
      Returns:
      a List<String>

    • getStartDateTime

      @Nullable public DateTimeTimeZone getStartDateTime()
      Gets the startDateTime property value. The startDateTime property
      Returns:
      a DateTimeTimeZone

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setAdditionalInformation

      public void setAdditionalInformation(@Nullable String value)
      Sets the additionalInformation property value. Additional information that is sent to the customer when an appointment is confirmed.
      Parameters:
      value - Value to set for the additionalInformation property.

    • setAnonymousJoinWebUrl

      public void setAnonymousJoinWebUrl(@Nullable String value)
      Sets the anonymousJoinWebUrl property value. The URL of the meeting to join anonymously.
      Parameters:
      value - Value to set for the anonymousJoinWebUrl property.

    • setAppointmentLabel

      public void setAppointmentLabel(@Nullable String value)
      Sets the appointmentLabel property value. The custom label that can be stamped on this appointment by users.
      Parameters:
      value - Value to set for the appointmentLabel property.

    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      Sets the createdDateTime property value. The date, time, and time zone when the appointment was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Parameters:
      value - Value to set for the createdDateTime property.

    • setCustomerEmailAddress

      public void setCustomerEmailAddress(@Nullable String value)
      Sets the customerEmailAddress property value. The SMTP address of the bookingCustomer who books the appointment.
      Parameters:
      value - Value to set for the customerEmailAddress property.

    • setCustomerName

      public void setCustomerName(@Nullable String value)
      Sets the customerName property value. The customer's name.
      Parameters:
      value - Value to set for the customerName property.

    • setCustomerNotes

      public void setCustomerNotes(@Nullable String value)
      Sets the customerNotes property value. Notes from the customer associated with this appointment. You can get the value only when you read this bookingAppointment by its ID. You can set this property only when you initially create an appointment with a new customer.
      Parameters:
      value - Value to set for the customerNotes property.

    • setCustomerPhone

      public void setCustomerPhone(@Nullable String value)
      Sets the customerPhone property value. The customer's phone number.
      Parameters:
      value - Value to set for the customerPhone property.

    • setCustomers

      public void setCustomers(@Nullable List<BookingCustomerInformationBase> value)
      Sets the customers property value. A collection of customer properties for an appointment. An appointment contains a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.
      Parameters:
      value - Value to set for the customers property.

    • setCustomerTimeZone

      public void setCustomerTimeZone(@Nullable String value)
      Sets the customerTimeZone property value. The time zone of the customer. For a list of possible values, see dateTimeTimeZone.
      Parameters:
      value - Value to set for the customerTimeZone property.

    • setDuration

      public void setDuration(@Nullable com.microsoft.kiota.PeriodAndDuration value)
      Sets the duration property value. The length of the appointment, denoted in ISO8601 format.
      Parameters:
      value - Value to set for the duration property.

    • setEndDateTime

      public void setEndDateTime(@Nullable DateTimeTimeZone value)
      Sets the endDateTime property value. The endDateTime property
      Parameters:
      value - Value to set for the endDateTime property.

    • setFilledAttendeesCount

      public void setFilledAttendeesCount(@Nullable Integer value)
      Sets the filledAttendeesCount property value. The current number of customers in the appointment.
      Parameters:
      value - Value to set for the filledAttendeesCount property.

    • setIsCustomerAllowedToManageBooking

      public void setIsCustomerAllowedToManageBooking(@Nullable Boolean value)
      Sets the isCustomerAllowedToManageBooking property value. Indicates that the customer can manage bookings created by the staff. The default value is false.
      Parameters:
      value - Value to set for the isCustomerAllowedToManageBooking property.

    • setIsLocationOnline

      public void setIsLocationOnline(@Nullable Boolean value)
      Sets the isLocationOnline property value. Indicates that the appointment is held online. The default value is false.
      Parameters:
      value - Value to set for the isLocationOnline property.

    • setJoinWebUrl

      public void setJoinWebUrl(@Nullable String value)
      Sets the joinWebUrl property value. The URL of the online meeting for the appointment.
      Parameters:
      value - Value to set for the joinWebUrl property.

    • setLastUpdatedDateTime

      public void setLastUpdatedDateTime(@Nullable OffsetDateTime value)
      Sets the lastUpdatedDateTime property value. The date, time, and time zone when the booking business was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Parameters:
      value - Value to set for the lastUpdatedDateTime property.

    • setMaximumAttendeesCount

      public void setMaximumAttendeesCount(@Nullable Integer value)
      Sets the maximumAttendeesCount property value. The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.
      Parameters:
      value - Value to set for the maximumAttendeesCount property.

    • setOptOutOfCustomerEmail

      public void setOptOutOfCustomerEmail(@Nullable Boolean value)
      Sets the optOutOfCustomerEmail property value. If true indicates that the bookingCustomer for this appointment doesn't wish to receive a confirmation for this appointment.
      Parameters:
      value - Value to set for the optOutOfCustomerEmail property.

    • setPostBuffer

      public void setPostBuffer(@Nullable com.microsoft.kiota.PeriodAndDuration value)
      Sets the postBuffer property value. The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.
      Parameters:
      value - Value to set for the postBuffer property.

    • setPreBuffer

      public void setPreBuffer(@Nullable com.microsoft.kiota.PeriodAndDuration value)
      Sets the preBuffer property value. The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.
      Parameters:
      value - Value to set for the preBuffer property.

    • setPrice

      public void setPrice(@Nullable Double value)
      Sets the price property value. The regular price for an appointment for the specified bookingService.
      Parameters:
      value - Value to set for the price property.

    • setPriceType

      public void setPriceType(@Nullable BookingPriceType value)
      Sets the priceType property value. Represents the type of pricing of a booking service.
      Parameters:
      value - Value to set for the priceType property.

    • setReminders

      public void setReminders(@Nullable List<BookingReminder> value)
      Sets the reminders property value. The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID.
      Parameters:
      value - Value to set for the reminders property.

    • setSelfServiceAppointmentId

      public void setSelfServiceAppointmentId(@Nullable String value)
      Sets the selfServiceAppointmentId property value. Another tracking ID for the appointment, if the appointment was created directly by the customer on the scheduling page, as opposed to by a staff member on behalf of the customer.
      Parameters:
      value - Value to set for the selfServiceAppointmentId property.

    • setServiceId

      public void setServiceId(@Nullable String value)
      Sets the serviceId property value. The ID of the bookingService associated with this appointment.
      Parameters:
      value - Value to set for the serviceId property.

    • setServiceLocation

      public void setServiceLocation(@Nullable Location value)
      Sets the serviceLocation property value. The location where the service is delivered.
      Parameters:
      value - Value to set for the serviceLocation property.

    • setServiceName

      public void setServiceName(@Nullable String value)
      Sets the serviceName property value. The name of the bookingService associated with this appointment.This property is optional when creating a new appointment. If not specified, it's computed from the service associated with the appointment by the serviceId property.
      Parameters:
      value - Value to set for the serviceName property.

    • setServiceNotes

      public void setServiceNotes(@Nullable String value)
      Sets the serviceNotes property value. Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.
      Parameters:
      value - Value to set for the serviceNotes property.

    • setSmsNotificationsEnabled

      public void setSmsNotificationsEnabled(@Nullable Boolean value)
      Sets the smsNotificationsEnabled property value. If true, indicates SMS notifications will be sent to the customers for the appointment. Default value is false.
      Parameters:
      value - Value to set for the smsNotificationsEnabled property.

    • setStaffMemberIds

      public void setStaffMemberIds(@Nullable List<String> value)
      Sets the staffMemberIds property value. The ID of each bookingStaffMember who is scheduled in this appointment.
      Parameters:
      value - Value to set for the staffMemberIds property.

    • setStartDateTime

      public void setStartDateTime(@Nullable DateTimeTimeZone value)
      Sets the startDateTime property value. The startDateTime property
      Parameters:
      value - Value to set for the startDateTime property.