Uses of Class
org.wso2.am.integration.clients.publisher.api.v1.dto.DocumentDTO

Packages that use DocumentDTO

Package	Description
org.wso2.am.integration.clients.publisher.api.v1
org.wso2.am.integration.clients.publisher.api.v1.dto

Uses of DocumentDTO in org.wso2.am.integration.clients.publisher.api.v1

Methods in org.wso2.am.integration.clients.publisher.api.v1 that return DocumentDTO

Modifier and Type	Method and Description
DocumentDTO	ApiDocumentsApi.addAPIDocument(String apiId, DocumentDTO documentDTO, String ifMatch) Add a New Document to an API This operation can be used to add a new documentation to an API.
DocumentDTO	ApiDocumentsApi.addAPIDocumentContent(String apiId, String documentId, String ifMatch, File file, String inlineContent) Upload the Content of an API Document Thid operation can be used to upload a file or add inline content to an API document.
DocumentDTO	ApiProductDocumentsApi.addAPIProductDocument(String apiProductId, DocumentDTO documentDTO) Add a New Document to an API Product This operation can be used to add a new documentation to an API Product.
DocumentDTO	ApiProductDocumentsApi.addAPIProductDocumentContent(String apiProductId, String documentId, String ifMatch, File file, String inlineContent) Upload the Content of an API Product Document Thid operation can be used to upload a file or add inline content to an API Product document.
DocumentDTO	ApiDocumentsApi.getAPIDocumentByDocumentId(String apiId, String documentId, String ifNoneMatch) Get a Document of an API This operation can be used to retrieve a particular document's metadata associated with an API.
DocumentDTO	ApiProductDocumentsApi.getAPIProductDocument(String apiProductId, String documentId, String accept, String ifNoneMatch) Get a Document of an API Product This operation can be used to retrieve a particular document's metadata associated with an API.
DocumentDTO	ApiDocumentsApi.updateAPIDocument(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API This operation can be used to update metadata of an API's document.
DocumentDTO	ApiProductDocumentsApi.updateAPIProductDocument(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API Product This operation can be used to update metadata of an API's document.

Methods in org.wso2.am.integration.clients.publisher.api.v1 that return types with arguments of type DocumentDTO

Modifier and Type	Method and Description
ApiResponse<DocumentDTO>	ApiDocumentsApi.addAPIDocumentContentWithHttpInfo(String apiId, String documentId, String ifMatch, File file, String inlineContent) Upload the Content of an API Document Thid operation can be used to upload a file or add inline content to an API document.
ApiResponse<DocumentDTO>	ApiDocumentsApi.addAPIDocumentWithHttpInfo(String apiId, DocumentDTO documentDTO, String ifMatch) Add a New Document to an API This operation can be used to add a new documentation to an API.
ApiResponse<DocumentDTO>	ApiProductDocumentsApi.addAPIProductDocumentContentWithHttpInfo(String apiProductId, String documentId, String ifMatch, File file, String inlineContent) Upload the Content of an API Product Document Thid operation can be used to upload a file or add inline content to an API Product document.
ApiResponse<DocumentDTO>	ApiProductDocumentsApi.addAPIProductDocumentWithHttpInfo(String apiProductId, DocumentDTO documentDTO) Add a New Document to an API Product This operation can be used to add a new documentation to an API Product.
ApiResponse<DocumentDTO>	ApiDocumentsApi.getAPIDocumentByDocumentIdWithHttpInfo(String apiId, String documentId, String ifNoneMatch) Get a Document of an API This operation can be used to retrieve a particular document's metadata associated with an API.
ApiResponse<DocumentDTO>	ApiProductDocumentsApi.getAPIProductDocumentWithHttpInfo(String apiProductId, String documentId, String accept, String ifNoneMatch) Get a Document of an API Product This operation can be used to retrieve a particular document's metadata associated with an API.
ApiResponse<DocumentDTO>	ApiDocumentsApi.updateAPIDocumentWithHttpInfo(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API This operation can be used to update metadata of an API's document.
ApiResponse<DocumentDTO>	ApiProductDocumentsApi.updateAPIProductDocumentWithHttpInfo(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API Product This operation can be used to update metadata of an API's document.

Methods in org.wso2.am.integration.clients.publisher.api.v1 with parameters of type DocumentDTO

Modifier and Type	Method and Description
DocumentDTO	ApiDocumentsApi.addAPIDocument(String apiId, DocumentDTO documentDTO, String ifMatch) Add a New Document to an API This operation can be used to add a new documentation to an API.
okhttp3.Call	ApiDocumentsApi.addAPIDocumentAsync(String apiId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Add a New Document to an API (asynchronously) This operation can be used to add a new documentation to an API.
okhttp3.Call	ApiDocumentsApi.addAPIDocumentCall(String apiId, DocumentDTO documentDTO, String ifMatch, ApiCallback _callback) Build call for addAPIDocument
ApiResponse<DocumentDTO>	ApiDocumentsApi.addAPIDocumentWithHttpInfo(String apiId, DocumentDTO documentDTO, String ifMatch) Add a New Document to an API This operation can be used to add a new documentation to an API.
DocumentDTO	ApiProductDocumentsApi.addAPIProductDocument(String apiProductId, DocumentDTO documentDTO) Add a New Document to an API Product This operation can be used to add a new documentation to an API Product.
okhttp3.Call	ApiProductDocumentsApi.addAPIProductDocumentAsync(String apiProductId, DocumentDTO documentDTO, ApiCallback<DocumentDTO> _callback) Add a New Document to an API Product (asynchronously) This operation can be used to add a new documentation to an API Product.
okhttp3.Call	ApiProductDocumentsApi.addAPIProductDocumentCall(String apiProductId, DocumentDTO documentDTO, ApiCallback _callback) Build call for addAPIProductDocument
ApiResponse<DocumentDTO>	ApiProductDocumentsApi.addAPIProductDocumentWithHttpInfo(String apiProductId, DocumentDTO documentDTO) Add a New Document to an API Product This operation can be used to add a new documentation to an API Product.
DocumentDTO	ApiDocumentsApi.updateAPIDocument(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API This operation can be used to update metadata of an API's document.
okhttp3.Call	ApiDocumentsApi.updateAPIDocumentAsync(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Update a Document of an API (asynchronously) This operation can be used to update metadata of an API's document.
okhttp3.Call	ApiDocumentsApi.updateAPIDocumentCall(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback _callback) Build call for updateAPIDocument
ApiResponse<DocumentDTO>	ApiDocumentsApi.updateAPIDocumentWithHttpInfo(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API This operation can be used to update metadata of an API's document.
DocumentDTO	ApiProductDocumentsApi.updateAPIProductDocument(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API Product This operation can be used to update metadata of an API's document.
okhttp3.Call	ApiProductDocumentsApi.updateAPIProductDocumentAsync(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Update a Document of an API Product (asynchronously) This operation can be used to update metadata of an API's document.
okhttp3.Call	ApiProductDocumentsApi.updateAPIProductDocumentCall(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback _callback) Build call for updateAPIProductDocument
ApiResponse<DocumentDTO>	ApiProductDocumentsApi.updateAPIProductDocumentWithHttpInfo(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of an API Product This operation can be used to update metadata of an API's document.

Method parameters in org.wso2.am.integration.clients.publisher.api.v1 with type arguments of type DocumentDTO

Modifier and Type	Method and Description
okhttp3.Call	ApiDocumentsApi.addAPIDocumentAsync(String apiId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Add a New Document to an API (asynchronously) This operation can be used to add a new documentation to an API.
okhttp3.Call	ApiDocumentsApi.addAPIDocumentContentAsync(String apiId, String documentId, String ifMatch, File file, String inlineContent, ApiCallback<DocumentDTO> _callback) Upload the Content of an API Document (asynchronously) Thid operation can be used to upload a file or add inline content to an API document.
okhttp3.Call	ApiProductDocumentsApi.addAPIProductDocumentAsync(String apiProductId, DocumentDTO documentDTO, ApiCallback<DocumentDTO> _callback) Add a New Document to an API Product (asynchronously) This operation can be used to add a new documentation to an API Product.
okhttp3.Call	ApiProductDocumentsApi.addAPIProductDocumentContentAsync(String apiProductId, String documentId, String ifMatch, File file, String inlineContent, ApiCallback<DocumentDTO> _callback) Upload the Content of an API Product Document (asynchronously) Thid operation can be used to upload a file or add inline content to an API Product document.
okhttp3.Call	ApiDocumentsApi.getAPIDocumentByDocumentIdAsync(String apiId, String documentId, String ifNoneMatch, ApiCallback<DocumentDTO> _callback) Get a Document of an API (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API.
okhttp3.Call	ApiProductDocumentsApi.getAPIProductDocumentAsync(String apiProductId, String documentId, String accept, String ifNoneMatch, ApiCallback<DocumentDTO> _callback) Get a Document of an API Product (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API.
okhttp3.Call	ApiDocumentsApi.updateAPIDocumentAsync(String apiId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Update a Document of an API (asynchronously) This operation can be used to update metadata of an API's document.
okhttp3.Call	ApiProductDocumentsApi.updateAPIProductDocumentAsync(String apiProductId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Update a Document of an API Product (asynchronously) This operation can be used to update metadata of an API's document.

Uses of DocumentDTO in org.wso2.am.integration.clients.publisher.api.v1.dto

Methods in org.wso2.am.integration.clients.publisher.api.v1.dto that return DocumentDTO

Modifier and Type	Method and Description
DocumentDTO	DocumentDTO.createdBy(String createdBy)
DocumentDTO	DocumentDTO.createdTime(String createdTime)
DocumentDTO	DocumentDTO.documentId(String documentId)
DocumentDTO	DocumentDTO.fileName(String fileName)
DocumentDTO	DocumentDTO.inlineContent(String inlineContent)
DocumentDTO	DocumentDTO.lastUpdatedBy(String lastUpdatedBy)
DocumentDTO	DocumentDTO.lastUpdatedTime(String lastUpdatedTime)
DocumentDTO	DocumentDTO.name(String name)
DocumentDTO	DocumentDTO.otherTypeName(String otherTypeName)
DocumentDTO	DocumentDTO.sourceType(DocumentDTO.SourceTypeEnum sourceType)
DocumentDTO	DocumentDTO.sourceUrl(String sourceUrl)
DocumentDTO	DocumentDTO.summary(String summary)
DocumentDTO	DocumentDTO.type(DocumentDTO.TypeEnum type)
DocumentDTO	DocumentDTO.visibility(DocumentDTO.VisibilityEnum visibility)

Methods in org.wso2.am.integration.clients.publisher.api.v1.dto that return types with arguments of type DocumentDTO

Modifier and Type	Method and Description
List<DocumentDTO>	DocumentListDTO.getList() Get list

Method parameters in org.wso2.am.integration.clients.publisher.api.v1.dto with type arguments of type DocumentDTO

Modifier and Type	Method and Description
DocumentListDTO	DocumentListDTO.list(List<DocumentDTO> list)
void	DocumentListDTO.setList(List<DocumentDTO> list)