///
///
/**
* Type Definitions for Gjs (https://gjs.guide/)
*
* These type definitions are automatically generated, do not edit them by hand.
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
*
* The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
*/
declare module 'gi://ICalGLib?version=3.0' {
// Module dependencies
import type GObject from 'gi://GObject?version=2.0';
import type GLib from 'gi://GLib?version=2.0';
export namespace ICalGLib {
/**
* ICalGLib-3.0
*/
export namespace ComponentKind {
export const $gtype: GObject.GType;
}
enum ComponentKind {
NO_COMPONENT,
ANY_COMPONENT,
XROOT_COMPONENT,
XATTACH_COMPONENT,
VEVENT_COMPONENT,
VTODO_COMPONENT,
VJOURNAL_COMPONENT,
VCALENDAR_COMPONENT,
VAGENDA_COMPONENT,
VFREEBUSY_COMPONENT,
VALARM_COMPONENT,
XAUDIOALARM_COMPONENT,
XDISPLAYALARM_COMPONENT,
XEMAILALARM_COMPONENT,
XPROCEDUREALARM_COMPONENT,
VTIMEZONE_COMPONENT,
XSTANDARD_COMPONENT,
XDAYLIGHT_COMPONENT,
X_COMPONENT,
VSCHEDULE_COMPONENT,
VQUERY_COMPONENT,
VREPLY_COMPONENT,
VCAR_COMPONENT,
VCOMMAND_COMPONENT,
XLICINVALID_COMPONENT,
XLICMIMEPART_COMPONENT,
VAVAILABILITY_COMPONENT,
XAVAILABLE_COMPONENT,
VPOLL_COMPONENT,
VVOTER_COMPONENT,
XVOTE_COMPONENT,
}
export namespace ErrorEnum {
export const $gtype: GObject.GType;
}
enum ErrorEnum {
NO_ERROR,
BADARG_ERROR,
NEWFAILED_ERROR,
ALLOCATION_ERROR,
MALFORMEDDATA_ERROR,
PARSE_ERROR,
INTERNAL_ERROR,
FILE_ERROR,
USAGE_ERROR,
UNIMPLEMENTED_ERROR,
UNKNOWN_ERROR,
}
export namespace ErrorState {
export const $gtype: GObject.GType;
}
enum ErrorState {
FATAL,
NONFATAL,
DEFAULT,
UNKNOWN,
}
export namespace ParameterAction {
export const $gtype: GObject.GType;
}
enum ParameterAction {
X,
ASK,
ABORT,
NONE,
}
export namespace ParameterCutype {
export const $gtype: GObject.GType;
}
enum ParameterCutype {
X,
INDIVIDUAL,
GROUP,
RESOURCE,
ROOM,
UNKNOWN,
NONE,
}
export namespace ParameterDisplay {
export const $gtype: GObject.GType;
}
enum ParameterDisplay {
X,
BADGE,
GRAPHIC,
FULLSIZE,
THUMBNAIL,
NONE,
}
export namespace ParameterEnable {
export const $gtype: GObject.GType;
}
enum ParameterEnable {
X,
TRUE,
FALSE,
NONE,
}
export namespace ParameterEncoding {
export const $gtype: GObject.GType;
}
enum ParameterEncoding {
X,
'8BIT',
BASE64,
NONE,
}
export namespace ParameterFbtype {
export const $gtype: GObject.GType;
}
enum ParameterFbtype {
X,
FREE,
BUSY,
BUSYUNAVAILABLE,
BUSYTENTATIVE,
NONE,
}
export namespace ParameterFeature {
export const $gtype: GObject.GType;
}
enum ParameterFeature {
X,
AUDIO,
CHAT,
FEED,
MODERATOR,
PHONE,
SCREEN,
VIDEO,
NONE,
}
export namespace ParameterKind {
export const $gtype: GObject.GType;
}
enum ParameterKind {
ANY_PARAMETER,
ACTIONPARAM_PARAMETER,
ALTREP_PARAMETER,
CHARSET_PARAMETER,
CN_PARAMETER,
CUTYPE_PARAMETER,
DELEGATEDFROM_PARAMETER,
DELEGATEDTO_PARAMETER,
DIR_PARAMETER,
DISPLAY_PARAMETER,
EMAIL_PARAMETER,
ENABLE_PARAMETER,
ENCODING_PARAMETER,
FBTYPE_PARAMETER,
FEATURE_PARAMETER,
FILENAME_PARAMETER,
FMTTYPE_PARAMETER,
IANA_PARAMETER,
ID_PARAMETER,
LABEL_PARAMETER,
LANGUAGE_PARAMETER,
LATENCY_PARAMETER,
LOCAL_PARAMETER,
LOCALIZE_PARAMETER,
MANAGEDID_PARAMETER,
MEMBER_PARAMETER,
MODIFIED_PARAMETER,
OPTIONS_PARAMETER,
PARTSTAT_PARAMETER,
PATCHACTION_PARAMETER,
PUBLICCOMMENT_PARAMETER,
RANGE_PARAMETER,
REASON_PARAMETER,
RELATED_PARAMETER,
RELTYPE_PARAMETER,
REQUIRED_PARAMETER,
RESPONSE_PARAMETER,
ROLE_PARAMETER,
RSVP_PARAMETER,
SCHEDULEAGENT_PARAMETER,
SCHEDULEFORCESEND_PARAMETER,
SCHEDULESTATUS_PARAMETER,
SENTBY_PARAMETER,
SIZE_PARAMETER,
STAYINFORMED_PARAMETER,
SUBSTATE_PARAMETER,
TZID_PARAMETER,
VALUE_PARAMETER,
X_PARAMETER,
XLICCOMPARETYPE_PARAMETER,
XLICERRORTYPE_PARAMETER,
NO_PARAMETER,
}
export namespace ParameterLocal {
export const $gtype: GObject.GType;
}
enum ParameterLocal {
X,
TRUE,
FALSE,
NONE,
}
export namespace ParameterPartstat {
export const $gtype: GObject.GType;
}
enum ParameterPartstat {
X,
NEEDSACTION,
ACCEPTED,
DECLINED,
TENTATIVE,
DELEGATED,
COMPLETED,
INPROCESS,
FAILED,
NONE,
}
export namespace ParameterPatchaction {
export const $gtype: GObject.GType;
}
enum ParameterPatchaction {
X,
CREATE,
BYNAME,
BYVALUE,
BYPARAM,
NONE,
}
export namespace ParameterRange {
export const $gtype: GObject.GType;
}
enum ParameterRange {
X,
THISANDPRIOR,
THISANDFUTURE,
NONE,
}
export namespace ParameterRelated {
export const $gtype: GObject.GType;
}
enum ParameterRelated {
X,
START,
END,
NONE,
}
export namespace ParameterReltype {
export const $gtype: GObject.GType;
}
enum ParameterReltype {
X,
PARENT,
CHILD,
SIBLING,
POLL,
NONE,
}
export namespace ParameterRequired {
export const $gtype: GObject.GType;
}
enum ParameterRequired {
X,
TRUE,
FALSE,
NONE,
}
export namespace ParameterRole {
export const $gtype: GObject.GType;
}
enum ParameterRole {
X,
CHAIR,
REQPARTICIPANT,
OPTPARTICIPANT,
NONPARTICIPANT,
NONE,
}
export namespace ParameterRsvp {
export const $gtype: GObject.GType;
}
enum ParameterRsvp {
X,
TRUE,
FALSE,
NONE,
}
export namespace ParameterScheduleagent {
export const $gtype: GObject.GType;
}
enum ParameterScheduleagent {
X,
SERVER,
CLIENT,
NONE,
}
export namespace ParameterScheduleforcesend {
export const $gtype: GObject.GType;
}
enum ParameterScheduleforcesend {
X,
REQUEST,
REPLY,
NONE,
}
export namespace ParameterStayinformed {
export const $gtype: GObject.GType;
}
enum ParameterStayinformed {
X,
TRUE,
FALSE,
NONE,
}
export namespace ParameterSubstate {
export const $gtype: GObject.GType;
}
enum ParameterSubstate {
X,
OK,
ERROR,
SUSPENDED,
NONE,
}
export namespace ParameterValue {
export const $gtype: GObject.GType;
}
enum ParameterValue {
X,
BINARY,
BOOLEAN,
DATE,
DURATION,
FLOAT,
INTEGER,
PERIOD,
RECUR,
TEXT,
URI,
ERROR,
DATETIME,
UTCOFFSET,
CALADDRESS,
NONE,
}
export namespace ParameterXliccomparetype {
export const $gtype: GObject.GType;
}
enum ParameterXliccomparetype {
X,
EQUAL,
NOTEQUAL,
LESS,
GREATER,
LESSEQUAL,
GREATEREQUAL,
REGEX,
ISNULL,
ISNOTNULL,
NONE,
}
export namespace ParameterXlicerrortype {
export const $gtype: GObject.GType;
}
enum ParameterXlicerrortype {
X,
COMPONENTPARSEERROR,
PROPERTYPARSEERROR,
PARAMETERNAMEPARSEERROR,
PARAMETERVALUEPARSEERROR,
VALUEPARSEERROR,
INVALIDITIP,
UNKNOWNVCALPROPERROR,
MIMEPARSEERROR,
VCALPROPPARSEERROR,
NONE,
}
export namespace ParserState {
export const $gtype: GObject.GType;
}
enum ParserState {
ERROR,
SUCCESS,
BEGIN_COMP,
END_COMP,
IN_PROGRESS,
}
export namespace PropertyAction {
export const $gtype: GObject.GType;
}
enum PropertyAction {
X,
AUDIO,
DISPLAY,
EMAIL,
PROCEDURE,
NONE,
}
export namespace PropertyBusytype {
export const $gtype: GObject.GType;
}
enum PropertyBusytype {
X,
BUSY,
BUSYUNAVAILABLE,
BUSYTENTATIVE,
NONE,
}
export namespace PropertyCarlevel {
export const $gtype: GObject.GType;
}
enum PropertyCarlevel {
X,
CARNONE,
CARMIN,
CARFULL1,
NONE,
}
export namespace PropertyCmd {
export const $gtype: GObject.GType;
}
enum PropertyCmd {
X,
ABORT,
CONTINUE,
CREATE,
DELETE,
GENERATEUID,
GETCAPABILITY,
IDENTIFY,
MODIFY,
MOVE,
REPLY,
SEARCH,
SETLOCALE,
NONE,
}
export namespace PropertyKind {
export const $gtype: GObject.GType;
}
enum PropertyKind {
ANY_PROPERTY,
ACCEPTRESPONSE_PROPERTY,
ACKNOWLEDGED_PROPERTY,
ACTION_PROPERTY,
ALLOWCONFLICT_PROPERTY,
ATTACH_PROPERTY,
ATTENDEE_PROPERTY,
BUSYTYPE_PROPERTY,
CALID_PROPERTY,
CALMASTER_PROPERTY,
CALSCALE_PROPERTY,
CAPVERSION_PROPERTY,
CARLEVEL_PROPERTY,
CARID_PROPERTY,
CATEGORIES_PROPERTY,
CLASS_PROPERTY,
CMD_PROPERTY,
COLOR_PROPERTY,
COMMENT_PROPERTY,
COMPLETED_PROPERTY,
COMPONENTS_PROPERTY,
CONTACT_PROPERTY,
CREATED_PROPERTY,
CSID_PROPERTY,
DATEMAX_PROPERTY,
DATEMIN_PROPERTY,
DECREED_PROPERTY,
DEFAULTCHARSET_PROPERTY,
DEFAULTLOCALE_PROPERTY,
DEFAULTTZID_PROPERTY,
DEFAULTVCARS_PROPERTY,
DENY_PROPERTY,
DESCRIPTION_PROPERTY,
DTEND_PROPERTY,
DTSTAMP_PROPERTY,
DTSTART_PROPERTY,
DUE_PROPERTY,
DURATION_PROPERTY,
ESTIMATEDDURATION_PROPERTY,
EXDATE_PROPERTY,
EXPAND_PROPERTY,
EXRULE_PROPERTY,
FREEBUSY_PROPERTY,
GEO_PROPERTY,
GRANT_PROPERTY,
ITIPVERSION_PROPERTY,
LASTMODIFIED_PROPERTY,
LOCATION_PROPERTY,
MAXCOMPONENTSIZE_PROPERTY,
MAXDATE_PROPERTY,
MAXRESULTS_PROPERTY,
MAXRESULTSSIZE_PROPERTY,
METHOD_PROPERTY,
MINDATE_PROPERTY,
MULTIPART_PROPERTY,
NAME_PROPERTY,
ORGANIZER_PROPERTY,
OWNER_PROPERTY,
PERCENTCOMPLETE_PROPERTY,
PERMISSION_PROPERTY,
POLLCOMPLETION_PROPERTY,
POLLITEMID_PROPERTY,
POLLMODE_PROPERTY,
POLLPROPERTIES_PROPERTY,
POLLWINNER_PROPERTY,
PRIORITY_PROPERTY,
PRODID_PROPERTY,
QUERY_PROPERTY,
QUERYLEVEL_PROPERTY,
QUERYID_PROPERTY,
QUERYNAME_PROPERTY,
RDATE_PROPERTY,
RECURACCEPTED_PROPERTY,
RECUREXPAND_PROPERTY,
RECURLIMIT_PROPERTY,
RECURRENCEID_PROPERTY,
RELATEDTO_PROPERTY,
RELCALID_PROPERTY,
REPEAT_PROPERTY,
REPLYURL_PROPERTY,
REQUESTSTATUS_PROPERTY,
RESOURCES_PROPERTY,
RESPONSE_PROPERTY,
RESTRICTION_PROPERTY,
RRULE_PROPERTY,
SCOPE_PROPERTY,
SEQUENCE_PROPERTY,
STATUS_PROPERTY,
STORESEXPANDED_PROPERTY,
SUMMARY_PROPERTY,
TARGET_PROPERTY,
TASKMODE_PROPERTY,
TRANSP_PROPERTY,
TRIGGER_PROPERTY,
TZID_PROPERTY,
TZIDALIASOF_PROPERTY,
TZNAME_PROPERTY,
TZOFFSETFROM_PROPERTY,
TZOFFSETTO_PROPERTY,
TZUNTIL_PROPERTY,
TZURL_PROPERTY,
UID_PROPERTY,
URL_PROPERTY,
VERSION_PROPERTY,
VOTER_PROPERTY,
X_PROPERTY,
XLICCLASS_PROPERTY,
XLICCLUSTERCOUNT_PROPERTY,
XLICERROR_PROPERTY,
XLICMIMECHARSET_PROPERTY,
XLICMIMECID_PROPERTY,
XLICMIMECONTENTTYPE_PROPERTY,
XLICMIMEENCODING_PROPERTY,
XLICMIMEFILENAME_PROPERTY,
XLICMIMEOPTINFO_PROPERTY,
NO_PROPERTY,
}
export namespace PropertyMethod {
export const $gtype: GObject.GType;
}
enum PropertyMethod {
X,
PUBLISH,
REQUEST,
REPLY,
ADD,
CANCEL,
REFRESH,
COUNTER,
DECLINECOUNTER,
CREATE,
READ,
RESPONSE,
MOVE,
MODIFY,
GENERATEUID,
DELETE,
NONE,
}
export namespace PropertyPollcompletion {
export const $gtype: GObject.GType;
}
enum PropertyPollcompletion {
X,
SERVER,
SERVERSUBMIT,
SERVERCHOICE,
CLIENT,
NONE,
}
export namespace PropertyPollmode {
export const $gtype: GObject.GType;
}
enum PropertyPollmode {
X,
BASIC,
NONE,
}
export namespace PropertyQuerylevel {
export const $gtype: GObject.GType;
}
enum PropertyQuerylevel {
X,
CALQL1,
CALQLNONE,
NONE,
}
export namespace PropertyStatus {
export const $gtype: GObject.GType;
}
enum PropertyStatus {
X,
TENTATIVE,
CONFIRMED,
COMPLETED,
NEEDSACTION,
CANCELLED,
INPROCESS,
DRAFT,
FINAL,
SUBMITTED,
PENDING,
FAILED,
DELETED,
NONE,
}
export namespace PropertyTaskmode {
export const $gtype: GObject.GType;
}
enum PropertyTaskmode {
X,
AUTOMATICCOMPLETION,
AUTOMATICFAILURE,
AUTOMATICSTATUS,
NONE,
}
export namespace PropertyTransp {
export const $gtype: GObject.GType;
}
enum PropertyTransp {
X,
OPAQUE,
OPAQUENOCONFLICT,
TRANSPARENT,
TRANSPARENTNOCONFLICT,
NONE,
}
export namespace PropertyXlicclass {
export const $gtype: GObject.GType;
}
enum PropertyXlicclass {
X,
PUBLISHNEW,
PUBLISHUPDATE,
PUBLISHFREEBUSY,
REQUESTNEW,
REQUESTUPDATE,
REQUESTRESCHEDULE,
REQUESTDELEGATE,
REQUESTNEWORGANIZER,
REQUESTFORWARD,
REQUESTSTATUS,
REQUESTFREEBUSY,
REPLYACCEPT,
REPLYDECLINE,
REPLYDELEGATE,
REPLYCRASHERACCEPT,
REPLYCRASHERDECLINE,
ADDINSTANCE,
CANCELEVENT,
CANCELINSTANCE,
CANCELALL,
REFRESH,
COUNTER,
DECLINECOUNTER,
MALFORMED,
OBSOLETE,
MISSEQUENCED,
UNKNOWN,
NONE,
}
export namespace Property_Class {
export const $gtype: GObject.GType;
}
enum Property_Class {
X,
PUBLIC,
PRIVATE,
CONFIDENTIAL,
NONE,
}
export namespace RecurrenceArrayMaxValues {
export const $gtype: GObject.GType;
}
enum RecurrenceArrayMaxValues {
RECURRENCE_ARRAY_MAX,
}
export namespace RecurrenceArraySizes {
export const $gtype: GObject.GType;
}
enum RecurrenceArraySizes {
SECOND_SIZE,
MINUTE_SIZE,
HOUR_SIZE,
MONTH_SIZE,
MONTHDAY_SIZE,
WEEKNO_SIZE,
YEARDAY_SIZE,
SETPOS_SIZE,
DAY_SIZE,
}
export namespace RecurrenceFrequency {
export const $gtype: GObject.GType;
}
enum RecurrenceFrequency {
SECONDLY_RECURRENCE,
MINUTELY_RECURRENCE,
HOURLY_RECURRENCE,
DAILY_RECURRENCE,
WEEKLY_RECURRENCE,
MONTHLY_RECURRENCE,
YEARLY_RECURRENCE,
NO_RECURRENCE,
}
export namespace RecurrenceSkip {
export const $gtype: GObject.GType;
}
enum RecurrenceSkip {
BACKWARD,
FORWARD,
OMIT,
UNDEFINED,
}
export namespace RecurrenceWeekday {
export const $gtype: GObject.GType;
}
enum RecurrenceWeekday {
NO_WEEKDAY,
SUNDAY_WEEKDAY,
MONDAY_WEEKDAY,
TUESDAY_WEEKDAY,
WEDNESDAY_WEEKDAY,
THURSDAY_WEEKDAY,
FRIDAY_WEEKDAY,
SATURDAY_WEEKDAY,
}
export namespace RequestStatus {
export const $gtype: GObject.GType;
}
enum RequestStatus {
UNKNOWN_STATUS,
'2_0_SUCCESS_STATUS',
'2_1_FALLBACK_STATUS',
'2_2_IGPROP_STATUS',
'2_3_IGPARAM_STATUS',
'2_4_IGXPROP_STATUS',
'2_5_IGXPARAM_STATUS',
'2_6_IGCOMP_STATUS',
'2_7_FORWARD_STATUS',
'2_8_ONEEVENT_STATUS',
'2_9_TRUNC_STATUS',
'2_10_ONETODO_STATUS',
'2_11_TRUNCRRULE_STATUS',
'3_0_INVPROPNAME_STATUS',
'3_1_INVPROPVAL_STATUS',
'3_2_INVPARAM_STATUS',
'3_3_INVPARAMVAL_STATUS',
'3_4_INVCOMP_STATUS',
'3_5_INVTIME_STATUS',
'3_6_INVRULE_STATUS',
'3_7_INVCU_STATUS',
'3_8_NOAUTH_STATUS',
'3_9_BADVERSION_STATUS',
'3_10_TOOBIG_STATUS',
'3_11_MISSREQCOMP_STATUS',
'3_12_UNKCOMP_STATUS',
'3_13_BADCOMP_STATUS',
'3_14_NOCAP_STATUS',
'3_15_INVCOMMAND',
'4_0_BUSY_STATUS',
'4_1_STORE_ACCESS_DENIED',
'4_2_STORE_FAILED',
'4_3_STORE_NOT_FOUND',
'5_0_MAYBE_STATUS',
'5_1_UNAVAIL_STATUS',
'5_2_NOSERVICE_STATUS',
'5_3_NOSCHED_STATUS',
'6_1_CONTAINER_NOT_FOUND',
'9_0_UNRECOGNIZED_COMMAND',
}
export namespace RestrictionKind {
export const $gtype: GObject.GType;
}
enum RestrictionKind {
NONE,
ZERO,
ONE,
ZEROPLUS,
ONEPLUS,
ZEROORONE,
ONEEXCLUSIVE,
ONEMUTUAL,
UNKNOWN,
}
export namespace Unknowntokenhandling {
export const $gtype: GObject.GType;
}
enum Unknowntokenhandling {
ASSUME_IANA_TOKEN,
DISCARD_TOKEN,
TREAT_AS_ERROR,
}
export namespace ValueKind {
export const $gtype: GObject.GType;
}
enum ValueKind {
ANY_VALUE,
ACTION_VALUE,
ATTACH_VALUE,
BINARY_VALUE,
BOOLEAN_VALUE,
BUSYTYPE_VALUE,
CALADDRESS_VALUE,
CARLEVEL_VALUE,
CLASS_VALUE,
CMD_VALUE,
DATE_VALUE,
DATETIME_VALUE,
DATETIMEDATE_VALUE,
DATETIMEPERIOD_VALUE,
DURATION_VALUE,
FLOAT_VALUE,
GEO_VALUE,
INTEGER_VALUE,
METHOD_VALUE,
PERIOD_VALUE,
POLLCOMPLETION_VALUE,
POLLMODE_VALUE,
QUERY_VALUE,
QUERYLEVEL_VALUE,
RECUR_VALUE,
REQUESTSTATUS_VALUE,
STATUS_VALUE,
STRING_VALUE,
TASKMODE_VALUE,
TEXT_VALUE,
TRANSP_VALUE,
TRIGGER_VALUE,
URI_VALUE,
UTCOFFSET_VALUE,
X_VALUE,
XLICCLASS_VALUE,
NO_VALUE,
}
function bt(): void;
/**
* Returns the error stored in the library. If no error, return I_CAL_NO_ERROR.
* @returns Return the error happened
*/
function errno_return(): ErrorEnum;
function error_clear_errno(): void;
/**
* Shout out the errors to the compiler.
*/
function error_crash_here(): void;
/**
* Gets the state of an error.
* @param error The error to be checked
* @returns The state of the @error
*/
function error_get_error_state(error: ErrorEnum | null): ErrorState;
/**
* Gets the #ICalErrorEnum in the string representation. This method called the icalerrorno_return to get
* the current error.
* @returns The string representation of the current error
*/
function error_perror(): string;
/**
* Restores the error to specified state.
* @param error The error to be restored
* @param es The error state to be restored
*/
function error_restore(error: string, es: ErrorState | null): void;
/**
* Sets the errno.
* @param x The error to be set
*/
function error_set_errno(x: ErrorEnum | null): void;
/**
* Sets the state to the corresponding error in the library.
* @param error The error enum
* @param state The error state
*/
function error_set_error_state(error: ErrorEnum | null, state: ErrorState | null): void;
function error_stop_here(): void;
/**
* Translates the #ICalErrorEnum to the string representation.
* @param e The #ICalErrorEnum to be translated
* @returns The string representation of @e
*/
function error_strerror(e: ErrorEnum | null): string;
/**
* Suppresses the error.
* @param error The error to be suppressed
* @returns The error state suppressed
*/
function error_supress(error: string): ErrorState;
/**
* Gets the setting of #ICalUnknowntokenhandling.
* @returns The setting of #ICalUnknowntokenhandling
*/
function get_unknown_token_handling_setting(): Unknowntokenhandling;
/**
* Adds an existing buffer to the buffer ring.
* @param buf The existing buffer to be added into the ical
*/
function memory_add_tmp_buffer(buf?: any | null): void;
/**
* Append the character to the buffer. Only use them on normally allocated memory, or on buffers created
* from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string
* has to resize a buffer on the ring, the ring will loose track of it an you will have memory problems.
* @param buf The buffer to be appended. It should not be the memory in ical.
* @param pos The position at which the new string to be appended
* @param ch The character to be allocated
*/
function memory_append_char(buf: number[], pos: number[], ch: number): [number[], number[]];
/**
* Appends the string to the buffer. Only use them on normally allocated memory, or on buffers created from
* icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string
* has to resize a buffer on the ring, the ring will loose track of it an you will have memory problems.
* @param buf The buffer to be appended. It should not be the memory in ical.
* @param pos The position at which the new string to be appended
* @param str The string to be allocated
*/
function memory_append_string(buf: number[], pos: number[], str: string): [number[], number[]];
/**
* Frees the buffer.
* @param buf The buffer to be freed
*/
function memory_free_buffer(buf?: any | null): void;
/**
* Creates a new buffer with target size. The caller should deallocate it when necessary.
* @param size The size of the new buffer to be created
* @returns The newly created buffer with the target size.
*/
function memory_new_buffer(size: number): any | null;
/**
* Resizes the buffer to the target size.
* @param buf The buffer needs to be resized
* @param size The target size the buffer to be resized to
* @returns The buffer after being resized.
*/
function memory_resize_buffer(buf: any | null, size: number): any | null;
/**
* A wrapper around strdup. Partly to trap calls to strdup, partly because in -ansi, gcc on Red Hat claims
* that strdup is undeclared.
* @param s The string to be cloned
* @returns The cloned string.
*/
function memory_strdup(s: string): string;
/**
* Creates a buffer with target size.
* @param size The size of the buffer to be created
* @returns The newly created buffer
*/
function memory_tmp_buffer(size: number): any | null;
/**
* Like strdup, but the buffer is on the ring.
* @param str The string to be copied
* @returns The new copy of the @str.
*/
function memory_tmp_copy(str: string): string;
/**
* Parses data to #ICalComponent using the given function.
* @param func The parsing function
* @returns The parsed #ICalComponent
*/
function mime_parse(func: MimeParseFunc): Component;
/**
* Fills an array with the 'count' number of occurrences generated by the rrule. Note that the times are
* returned in UTC, but the times are calculated in local time. YOu will have to convert the results back
* into local time before using them.
* @param rule The rule of the recurrence
* @param start The start seconds past the POSIX epoch
* @param count The number of elements to be filled up in the @array
* @returns If successful, return the array. NULL if failed.
*/
function recur_expand_recurrence(rule: string, start: never, count: number): never[];
/**
* Returns the code for a request status.
* @param stat The #ICalRequestStatus to be queried
* @returns The code for a request status
*/
function request_status_code(stat: RequestStatus | null): string;
/**
* Returns the descriptive text for a request status.
* @param stat The #ICalRequestStatus to be translated
* @returns The description of the @stat
*/
function request_status_desc(stat: RequestStatus | null): string;
/**
* Returns a request status for major/minor status numbers.
* @param major The major number
* @param minor The minor number
* @returns The corresponding #ICalRequestStatus
*/
function request_status_from_num(major: number, minor: number): RequestStatus;
/**
* Returns the major number for a request status.
* @param stat The #ICalRequestStatus to be queried
* @returns The major number for a request status
*/
function request_status_major(stat: RequestStatus | null): number;
/**
* Returns the minor number for a request status.
* @param stat The #ICalRequestStatus to be queried
* @returns The minor number for a request status
*/
function request_status_minor(stat: RequestStatus | null): number;
/**
* Checks whether the #ICalComponent is valid.
* @param comp The component to be checked
* @returns Whether the @comp is valid.
*/
function restriction_check(comp: Component): number;
/**
* Compares the kind of restriction and the count to determine whether it is valid.
* @param restr The restriction kind
* @param count The number of restrictions
* @returns Whether it is valid or not. -1 indicates invalid or more analysis. 1 indicates pass and 0 or 2+ indicates fail.
*/
function restriction_compare(restr: RestrictionKind | null, count: number): number;
/**
* Sets #ICalUnknowntokenhandling.
* @param newSetting A #ICalUnknowntokenhandling
*/
function set_unknown_token_handling_setting(newSetting: Unknowntokenhandling | null): void;
interface ComponentForeachRecurrenceFunc {
(comp: Component, span: TimeSpan): void;
}
interface ComponentForeachTZIDFunc {
(param: Parameter): void;
}
interface MimeParseFunc {
(bytes: number[]): string;
}
interface ParserLineGenFunc {
(bytes: number[]): string;
}
module Array {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalArray instance.
*/
class Array extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
// Methods
/**
* Creates a deep copy of #ICalArray with the same properties as the `array`.
* @returns The newly cloned #ICalArray with the same value as the @array
*/
copy(): Array;
/**
* Removes the element at the `position` from the array.
* @param position The position in which the element will be removed from the array
*/
remove_element_at(position: number): void;
/**
* Gets the size of the array.
* @returns The size of current array.
*/
size(): number;
}
module Attach {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalAttach instance.
*/
class Attach extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
static new_from_bytes(bytes: GLib.Bytes | Uint8Array): Attach;
static new_from_data(data: string, free_fn?: GLib.Func | null): Attach;
static new_from_url(url: string): Attach;
// Methods
/**
* Gets the data, if the #ICalAttach is built from the data.
* @returns The data component of the @attach. %NULL if it is built from url or there is an error.
*/
get_data(): string | null;
// Conflicted with GObject.Object.get_data
get_data(...args: never[]): any;
/**
* Checks whether the #ICalAttach is built from url.
* @returns Whether the @attach is built from url
*/
get_is_url(): boolean;
/**
* Gets the url, if the #ICalAttach is built from the url.
* @returns The url component of the @attach. %NULL if it is built from data or there is an error.
*/
get_url(): string | null;
}
module CompIter {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalCompIter instance.
*/
class CompIter extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
// Methods
/**
* Gets the current #ICalComponent pointed by #ICalCompIter.
* @returns A #ICalComponent
*/
deref(): Component;
/**
* Gets the next #ICalComponent pointed by #ICalCompIter.
* @returns A #ICalCompIter
*/
next(): Component;
/**
* Gets the prior #ICalComponent pointed by #ICalCompIter.
* @returns A #ICalCompIter
*/
prior(): Component;
}
module Component {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalComponent instance.
*/
class Component extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
static ['new'](kind: ComponentKind): Component;
static new_from_string(str: string): Component;
static new_vagenda(): Component;
static new_valarm(): Component;
static new_vavailability(): Component;
static new_vcalendar(): Component;
static new_vevent(): Component;
static new_vfreebusy(): Component;
static new_vjournal(): Component;
static new_vpoll(): Component;
static new_vquery(): Component;
static new_vtimezone(): Component;
static new_vtodo(): Component;
static new_vvoter(): Component;
static new_x(x_name: string): Component;
static new_xavailable(): Component;
static new_xdaylight(): Component;
static new_xstandard(): Component;
static new_xvote(): Component;
// Static methods
/**
* Converts a string to a #ICalComponentKind.
* @param string A string
*/
static kind_from_string(string: string): ComponentKind;
/**
* Checks if a #ICalComponentKind is valid.
* @param kind A #ICalComponentKind
*/
static kind_is_valid(kind: ComponentKind): boolean;
/**
* Converts a #ICalComponentKind to a string.
* @param kind A #ICalComponentKind
*/
static kind_to_string(kind: ComponentKind): string;
// Methods
/**
* Adds a #ICalComponent into another #ICalComponent as a child component.
* @param child A child #ICalComponent
*/
add_component(child: Component): void;
/**
* Adds an #ICalProperty into #ICalComponent.
* @param property An #ICalProperty
*/
add_property(property: Property): void;
/**
* Converts a #ICalComponent to a string.
* @returns The string representation of #ICalComponent.
*/
as_ical_string(): string;
/**
* Gets the #ICalCompIter pointing to the first child #ICalComponent.
* @param kind A #ICalComponentKind
* @returns A #ICalCompIter
*/
begin_component(kind: ComponentKind | null): CompIter;
/**
* Checks the number of restrictions in #ICalComponent.
* @returns The number of restrictions in @comp
*/
check_restrictions(): number;
/**
* Deeply clone a #ICalComponent.
* @returns The newly deeply cloned #ICalComponent.
*/
clone(): Component;
/**
* Converts some X-LIC-ERROR properties into RETURN-STATUS properties.
*/
convert_errors(): void;
/**
* Counts the child #ICalComponent with the target kind in the parent one.
* @param kind The target #ICalComponentKind
* @returns The count of child #ICalComponent in the parent one.
*/
count_components(kind: ComponentKind | null): number;
/**
* Counts the number of errors in #ICalComponent.
* @returns The count of errors.
*/
count_errors(): number;
/**
* Counts the number of #ICalProperty in #ICalComponent.
* @param kind A #ICalPropertyKind
* @returns The number of #ICalProperty.
*/
count_properties(kind: PropertyKind | null): number;
/**
* Gets the #ICalCompIter pointing to the end child #ICalComponent.
* @param kind A #ICalComponentKind
* @returns A #ICalCompIter
*/
end_component(kind: ComponentKind | null): CompIter;
/**
* Cycles through all recurrences of an event. This function will call the specified callback function for
* once for the base value of DTSTART, and foreach recurring date/time value. It will filter out events
* that are specified as an EXDATE or an EXRULE.
* @param start Ignore timespans before this
* @param end Ignore timespans after this
* @param callback Function called for each timespan within the range
*/
foreach_recurrence(start: Time, end: Time, callback: ComponentForeachRecurrenceFunc): void;
/**
* Applies the same manipulation on every tzid in #ICalComponent.
* @param callback The callback function
*/
foreach_tzid(callback: ComponentForeachTZIDFunc): void;
/**
* Gets the comment of the #ICalComponent.
* @returns The comment of @comp.
*/
get_comment(): string;
/**
* Gets the current #ICalComponent in #ICalComponent.
* @returns The current #ICalComponent.
*/
get_current_component(): Component;
/**
* Gets the current #ICalProperty in #ICalComponent.
* @returns The current #ICalProperty.
*/
get_current_property(): Property;
/**
* Gets the description of the #ICalComponent.
* @returns The description of @comp.
*/
get_description(): string;
/**
* Gets the dtend of the #ICalComponent.
* @returns A #ICalTime.
*/
get_dtend(): Time;
/**
* Gets the dtstamp of the #ICalComponent.
* @returns A #ICalTime.
*/
get_dtstamp(): Time;
/**
* Gets the dtstart of the #ICalComponent.
* @returns A #ICalTime.
*/
get_dtstart(): Time;
/**
* Gets the due of the #ICalComponent.
* @returns A #ICalTime.
*/
get_due(): Time;
/**
* Gets the duration of the #ICalComponent.
* @returns An #ICalDuration.
*/
get_duration(): Duration;
/**
* Gets the first #ICalComponent with specific kind in #ICalComponent.
* @param kind A #ICalComponentKind
* @returns The first #ICalComponent.
*/
get_first_component(kind: ComponentKind | null): Component | null;
/**
* Gets the first #ICalProperty with specific kind in #ICalComponent.
* @param kind A #ICalPropertyKind
* @returns The first #ICalProperty.
*/
get_first_property(kind: PropertyKind | null): Property | null;
/**
* For VCOMPONENT: Returns a reference to the first VEVENT, VTODO or VJOURNAL.
* @returns A reference to the first VEVENT, VTODO or VJOURNAL
*/
get_first_real_component(): Component;
/**
* Returns the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types.
* @returns The first VEVENT, VTODO or VJOURNAL sub-component.
*/
get_inner(): Component | null;
/**
* Gets the location of the #ICalComponent.
* @returns The location of @comp.
*/
get_location(): string;
/**
* Gets the method of the #ICalComponent.
* @returns A #ICalPropertyMethod.
*/
get_method(): PropertyMethod;
/**
* Gets the next #ICalComponent with specific kind in #ICalComponent.
* @param kind A #ICalComponentKind
* @returns The next #ICalComponent.
*/
get_next_component(kind: ComponentKind | null): Component | null;
/**
* Gets the next #ICalProperty with specific kind in #ICalComponent.
* @param kind A #ICalPropertyKind
* @returns The next #ICalProperty.
*/
get_next_property(kind: PropertyKind | null): Property | null;
/**
* Gets the parent component of the `component`.
* @returns The parent #ICalComponent of the @component.
*/
get_parent(): Component | null;
/**
* Gets the recurrenceid of the #ICalComponent.
* @returns A #ICalTime.
*/
get_recurrenceid(): Time;
/**
* Gets the relcalid of the #ICalComponent.
* @returns The relcalid of @comp.
*/
get_relcalid(): string;
/**
* Gets the sequence of the #ICalComponent.
* @returns The sequence of @comp.
*/
get_sequence(): number;
/**
* For VEVENT, VTODO, VJOURNAL and VTIMEZONE: reports the start and end times of an event in UTC.
* @returns A #ICalTimeSpan.
*/
get_span(): TimeSpan;
/**
* Gets the status of the #ICalComponent.
* @returns A #ICalPropertyStatus.
*/
get_status(): PropertyStatus;
/**
* Gets the summary of the #ICalComponent.
* @returns The summary of @comp.
*/
get_summary(): string;
/**
* Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
* @param tzid A string representing timezone
* @returns A #ICalTimezone.
*/
get_timezone(tzid: string): Timezone | null;
/**
* Gets the uid of the #ICalComponent.
* @returns The uid of @comp.
*/
get_uid(): string;
/**
* Checks whether #ICalComponent is valid.
* @returns 1 if yes, 0 if not.
*/
is_valid(): boolean;
/**
* Gets the type of #ICalComponent.
* @returns A #ICalComponentKind.
*/
isa(): ComponentKind;
/**
* Checks whether the native part of #ICalComponent is icalcomponent.
* @returns 1 if yes, 0 if not.
*/
isa_component(): number;
/**
* Takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting
* TZIDs. comp_to_merge will no longer exist after calling this function.
* @param comp_to_merge A #ICalComponent. After merged it will not exist any more.
*/
merge_component(comp_to_merge: Component): void;
/**
* Removes a child #ICalComponent from another #ICalComponent.
* @param child A child #ICalComponent
*/
remove_component(child: Component): void;
/**
* Removes #ICalProperty from #ICalComponent. Caution: The compare is based on address. So you must use
* the original #ICalProperty as the target.
* @param property A #ICalProperty
*/
remove_property(property: Property): void;
/**
* Sets the comment of the #ICalComponent.
* @param v A string representing comment
*/
set_comment(v: string): void;
/**
* Sets the description of the #ICalComponent.
* @param v A string representing description
*/
set_description(v: string): void;
/**
* Sets the dtend of the #ICalComponent.
* @param v A #ICalTime
*/
set_dtend(v: Time): void;
/**
* Sets the dtstamp of the #ICalComponent.
* @param v A #ICalTime
*/
set_dtstamp(v: Time): void;
/**
* Sets the dtstart of the #ICalComponent.
* @param v A #ICalTime
*/
set_dtstart(v: Time): void;
/**
* Sets the due of the #ICalComponent.
* @param v A #ICalTime
*/
set_due(v: Time): void;
/**
* Sets the duration of the #ICalComponent.
* @param v A #ICalDuration
*/
set_duration(v: Duration): void;
/**
* Sets the location of the #ICalComponent.
* @param v A string representing location
*/
set_location(v: string): void;
/**
* Sets the method of the #ICalComponent.
* @param method A #ICalPropertyMethod
*/
set_method(method: PropertyMethod | null): void;
/**
* Sets the `parent` #ICalComponent of the specified `component`.
* @param parent An #ICalComponent, a new parent
*/
set_parent(parent?: Component | null): void;
/**
* Sets the recurrenceid of the #ICalComponent.
* @param v A #ICalTime
*/
set_recurrenceid(v: Time): void;
/**
* Sets the relcalid of the #ICalComponent.
* @param v A string representing relcalid
*/
set_relcalid(v: string): void;
/**
* Sets the sequence of the #ICalComponent.
* @param v The sequence number
*/
set_sequence(v: number): void;
/**
* Sets the status of the #ICalComponent.
* @param status A #ICalPropertyStatus
*/
set_status(status: PropertyStatus | null): void;
/**
* Sets the summary of the #ICalComponent.
* @param v A string representing summary
*/
set_summary(v: string): void;
/**
* Sets the uid of the #ICalComponent.
* @param v A string representing uid
*/
set_uid(v: string): void;
/**
* Removes all X-LIC-ERROR properties.
*/
strip_errors(): void;
}
module Datetimeperiod {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalDatetimeperiod instance.
*/
class Datetimeperiod extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
static ['new'](): Datetimeperiod;
// Methods
/**
* Gets the period attribute of #ICalDatetimeperiod.
* @returns The period attribute of @dtp.
*/
get_period(): Period;
/**
* Gets the time attribute of #ICalDatetimeperiod.
* @returns The time attribute of @dtp.
*/
get_time(): Time;
/**
* Sets the period attribute of #ICalDatetimeperiod.
* @param period The period attribute of @dtp
*/
set_period(period: Period): void;
/**
* Sets the time attribute of #ICalDatetimeperiod.
* @param time The time attribute of @dtp
*/
set_time(time: Time): void;
}
module Duration {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalDuration instance.
*/
class Duration extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
static new_bad_duration(): Duration;
static new_from_int(t: number): Duration;
static new_from_string(str: string): Duration;
static new_null_duration(): Duration;
// Methods
/**
* Converts the #ICalDuration to the representation in string.
* @returns The duration in string
*/
as_ical_string(): string;
/**
* Converts the #ICalDuration to the representation in second.
* @returns The duration in second
*/
as_int(): number;
/**
* Gets the days of #ICalDuration.
* @returns The days.
*/
get_days(): number;
/**
* Gets the hours of #ICalDuration.
* @returns The hours.
*/
get_hours(): number;
/**
* Gets the minutes of #ICalDuration.
* @returns The minutes.
*/
get_minutes(): number;
/**
* Gets the seconds of #ICalDuration.
* @returns The seconds.
*/
get_seconds(): number;
/**
* Gets the weeks of #ICalDuration.
* @returns The weeks.
*/
get_weeks(): number;
/**
* Checks whether the #ICalDuration is the bad_duration.
* @returns 1 if @duration is the bad_duration, 0 if not.
*/
is_bad_duration(): boolean;
/**
* Gets the is_neg of #ICalDuration.
* @returns The is_neg.
*/
is_neg(): boolean;
/**
* Checks whether the #ICalDuration is the null_duration.
* @returns 1 if @duration is the null_duration, 0 if not.
*/
is_null_duration(): boolean;
/**
* Sets the days of #ICalDuration.
* @param days The days
*/
set_days(days: number): void;
/**
* Sets the hours of #ICalDuration.
* @param hours The hours
*/
set_hours(hours: number): void;
/**
* Sets the is_neg of #ICalDuration.
* @param is_neg The is_neg
*/
set_is_neg(is_neg: boolean): void;
/**
* Sets the minutes of #ICalDuration.
* @param minutes The minutes
*/
set_minutes(minutes: number): void;
/**
* Sets the seconds of #ICalDuration.
* @param seconds The seconds
*/
set_seconds(seconds: number): void;
/**
* Sets the weeks of #ICalDuration.
* @param weeks The weeks
*/
set_weeks(weeks: number): void;
}
module Geo {
// Constructor properties interface
interface ConstructorProps extends Object.ConstructorProps {}
}
/**
* This is the ICalGeo instance.
*/
class Geo extends Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
static ['new'](lat: number, lon: number): Geo;
// Methods
/**
* Creates a new #ICalGeo, copy of `geo`.
* @returns The newly created #ICalGeo, copy of @geo.
*/
clone(): Geo;
/**
* Gets the latitude of #ICalGeo.
* @returns The latitude.
*/
get_lat(): number;
/**
* Gets the longitude of #ICalGeo.
* @returns The longitude.
*/
get_lon(): number;
/**
* Sets the latitude of #ICalGeo.
* @param lat The latitude
*/
set_lat(lat: number): void;
/**
* Sets the longitude of #ICalGeo.
* @param lon The longitude
*/
set_lon(lon: number): void;
}
module Object {
// Constructor properties interface
interface ConstructorProps extends GObject.Object.ConstructorProps {
always_destroy: boolean;
alwaysDestroy: boolean;
is_global_memory: boolean;
isGlobalMemory: boolean;
native: any;
native_destroy_func: any;
nativeDestroyFunc: any;
owner: GObject.Object;
}
}
/**
* This is an ICalObject instance struct.
*/
abstract class Object extends GObject.Object {
static $gtype: GObject.GType