Class: Entity

Sets the content-type to the entity.

1mime:InvalidContentTypeError? contentType = mimeEntity.setContentType("application/json");

Gets the content type of the entity.

1string contentType = mimeEntity.getContentType();

Sets the content ID of the entity.

1mimeEntity.setContentId("test-id");

Gets the content ID of the entity.

1string contentId = mimeEntity.getContentId();

Sets the content length of the entity.

1mimeEntity.setContentLength(45555);

Gets the content length of the entity.

1int|error contentLength = mimeEntity.getContentLength();

Sets the content disposition of the entity.

1mimeEntity.setContentDisposition(contentDisposition);

Gets the content disposition of the entity.

1mime:ContentDisposition contentDisposition = mimeEntity.getContentDisposition();

Sets the body of the entity with the given content. Note that any string value is set as text/plain. To send a JSON-compatible string, set the content-type header to application/json or use the setJsonPayload method instead.

1mimeEntity.setBody("body string");

Sets the entity body with a given file. This method overrides any existing content-type headers with the default content-type, which is application/octet-stream. This default value can be overridden by passing the content type as an optional parameter.

1mimeEntity.setFileAsEntityBody("<file path>");

Sets the entity body with the given json content. This method overrides any existing content-type headers with the default content-type, which is application/json. This default value can be overridden by passing the content type as an optional parameter.

1mimeEntity.setJson({ "Hello": "World" });

Extracts the JSON body from the entity.

1json|mime:ParserError result = entity.getJson();

Sets the entity body with the given XML content. This method overrides any existing content-type headers with the default content-type, which is application/xml. This default value can be overridden by passing the content-type as an optional parameter.

1mimeEntity.setXml(xml `<hello> world </hello>`);

Extracts the xml body from the entity.

1xml|mime:ParserError result = entity.getXml();

Sets the entity body with the given text content. This method overrides any existing content-type headers with the default content-type, which is text/plain. This default value can be overridden by passing the content type as an optional parameter.

1mimeEntity.setText("Hello World");

Extracts the text body from the entity. If the entity body is not text compatible, an error is returned.

1string|mime:ParserError result = entity.getText();

Sets the entity body with the given byte[] content. This method overrides any existing content-type headers with the default content-type, which is application/octet-stream. This default value can be overridden by passing the content type as an optional parameter.

1entity.setByteArray(content.toBytes());

Gets the entity body as a byte[] from a given entity. If the entity size is considerably large, consider using the Entity.getByteStream() method instead.

1byte[]|mime:ParserError result = entity.getByteArray();

Sets the entity body with the given byte stream content. This method overrides any existing content-type headers with the default content-type, which is application/octet-stream. This default value can be overridden by passing the content-type as an optional parameter.

1entity.setByteStream(byteStream);

Gets the entity body as a stream of byte[] from a given entity.

1stream<byte[], io:Error?>|mime:ParserError str = entity.getByteStream();

Gets the body parts from a given entity.

1mime:Entity[]|mime:ParserError result = multipartEntity.getBodyParts();

Gets the body parts as a byte stream from a given entity.

1stream<byte[], io:Error?>|mime:ParserError str = multipartEntity.getBodyPartsAsStream();

Sets the body parts to the entity. This method overrides any existing content-type headers with the default multipart/form-data content-type. The default multipart/form-data value can be overridden by passing the content type as an optional parameter.

1multipartEntity.setBodyParts(bodyParts, contentType);

Gets the header value associated with the given header name.

1string|mime:HeaderNotFoundError headerName = mimeEntity.getHeader(mime:CONTENT_LENGTH);

Gets all the header values associated with the given header name.

1string[]|mime:HeaderNotFoundError headerNames = mimeEntity.getHeaders(mime:CONTENT_TYPE);

Gets all the header names.

1string[] headerNames = mimeEntity.getHeaderNames();

Adds the given header value against the given header. Panic if an illegal header is passed.

1mimeEntity.addHeader("custom-header", "header-value");

Sets the given header value against the existing header. If a header already exists, its value is replaced with the given header value. Panic if an illegal header is passed.

1mimeEntity.setHeader("custom-header", "header-value");

Removes the given header from the entity.

1mimeEntity.removeHeader("custom-header");

Removes all headers associated with the entity.

1mimeEntity.removeAllHeaders();

Checks whether the requested header key exists in the header map.

1boolean res = mimeEntity.hasHeader("custom-header");