• Articles
  • Api Documentation
Show / Hide Table of Contents
  • PAccess.PartnerAgents
    • Api.Contracts
      • Branches
        • BranchAddress
        • BranchDetails
      • Customer
        • CreateCustomerRequest
        • CreateCustomerResponse
        • CustomerAddress
      • Property
        • ApiPropertyType
        • AuctionBidDetails
        • AuctionBidSummary
        • AuctionDetails
        • CentralHeatingType
        • CommercialBusinessType
        • CommercialPropertyDetails
        • CommercialPropertyType
        • GetPropertiesRequest
        • IReferredRequest
        • ListDataInfo
        • ParkingType
        • PropertyAddress
        • PropertyDetails
        • PropertyStatus
        • PropertySummary
        • ReferCommercialPropertyRequest
        • ReferPropertyResponse
        • ReferResidentialPropertyRequest
        • ResidentialPropertyDetails
        • ResidentialPropertyType
      • PropertyImage
        • AddPropertyImageRequest
        • AddPropertyImageResponse
        • PropertyImageDetails
        • RemovePropertyImageRequest
        • RemovePropertyImageResponse
        • SortPropertyImagesRequest
        • SortPropertyImagesResponse
      • PropertyNote
        • PropertyNoteDetails
      • Users
        • CreateUserRequest
        • CreateUserResponse
        • UserDetails
      • Viewing
        • AddViewingFeedbackRequest
        • AddViewingFeedbackResponse
        • CancelViewingRequest
        • CancelViewingResponse
        • CreateViewingRequest
        • CreateViewingResponse
        • RescheduleViewingRequest
        • RescheduleViewingResponse
        • ViewingDetails
      • ApiClientDetails
      • ErrorResponse
      • IApiAddress
      • IApiResponse
    • ApiClient
      • Configuration
        • PartnerAgentApiClientSettings
      • Factories
        • IPartnerAgentApiClientFactory
        • PartnerAgentApiClientFactory
      • Services
        • Branches
          • IPartnerAgentBranches
        • BusinessTypes
          • IPartnerAgentCommercialBusinessTypes
        • CentralHeatingTypes
          • IPartnerAgentCentralHeatingTypes
        • Customers
          • IPartnerAgentCustomers
        • ParkingTypes
          • IPartnerAgentParkingTypes
        • Properties
          • IPartnerAgentProperties
        • PropertyImages
          • IPartnerAgentPropertyImages
        • PropertyNotes
          • IPartnerAgentPropertyNotes
        • PropertyTypes
          • IPartnerAgentCommercialPropertyTypes
          • IPartnerAgentResidentialPropertyTypes
        • RequestExecution
          • NullableReferenceTypesExtensions
        • TokenValidation
          • IPartnerAgentTokenValidation
        • Users
          • IPartnerAgentUsers
        • Viewings
          • IPartnerAgentViewings
      • IPartnerAgentApiClient

Interface IPartnerAgentPropertyImages

Represents the interface for property image-related operations in the Partner Agent API client.

Namespace: PAccess.PartnerAgents.ApiClient.Services.PropertyImages
Assembly: PAccess.PartnerAgents.ApiClient.dll
Syntax
public interface IPartnerAgentPropertyImages

Methods

View Source

AddPropertyImageAsync(AddPropertyImageRequest, CancellationToken)

Adds a property image asynchronously.

Declaration
Task<AddPropertyImageResponse> AddPropertyImageAsync(AddPropertyImageRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AddPropertyImageRequest request

The request object containing the details of the property image addition.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<AddPropertyImageResponse>

A task representing the asynchronous operation that returns the response of the property image addition.

View Source

GetPropertyImagesAsync(int, CancellationToken)

Retrieves the property images asynchronously.

Declaration
Task<IReadOnlyList<PropertyImageDetails>?> GetPropertyImagesAsync(int id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The ID of the property.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<IReadOnlyList<PropertyImageDetails>>

A task representing the asynchronous operation that returns the list of property images.

View Source

RemovePropertyImageAsync(RemovePropertyImageRequest, CancellationToken)

Removes a property image asynchronously.

Declaration
Task<RemovePropertyImageResponse> RemovePropertyImageAsync(RemovePropertyImageRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
RemovePropertyImageRequest request

The request object containing the details of the property image removal.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<RemovePropertyImageResponse>

A task representing the asynchronous operation that returns the response of the property image removal.

View Source

SortPropertyImagesAsync(SortPropertyImagesRequest, CancellationToken)

Sorts the property images asynchronously.

Declaration
Task<SortPropertyImagesResponse> SortPropertyImagesAsync(SortPropertyImagesRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SortPropertyImagesRequest request

The request object containing the details of the property image sorting.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<SortPropertyImagesResponse>

A task representing the result of the asynchronous operation that returns the list of sorted property images.

  • View Source
In This Article
Back to top Generated by DocFX