PlainApp
API குறிப்பு

ஆவணங்கள்

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், ID-கள், உள்ளீடுகள் மற்றும் வடிப்பான்களை மாற்றவும்.

வகை வரையறைகள்

graphql
type Query {
  docCount(query: String!): Int!
  docExtGroups(query: String! = ""): [DocExtGroup!]!
  docs(query: String!, offset: Int!, limit: Int!, sortBy: DocSortBy!): [Doc!]!
}

enum DataType {
	DEFAULT
	AUDIO
	VIDEO
	IMAGE
	SMS
	CONTACT
	NOTE
	FEED_ENTRY
	CALL
	PACKAGE
	FILE
	APP_FILE
	DOC
}

type Doc implements MediaItem {
	id: ID!
	title: String!
	path: String!
	extension: String!
	size: Long!
	bucketId: ID!
	createdAt: Instant!
	updatedAt: Instant!
	tags: [Tag!]!
}

type DocExtGroup {
	ext: String!
	count: Int!
}

enum DocSortBy {
	UPDATED_AT_ASC
	UPDATED_AT_DESC
	SIZE_ASC
	SIZE_DESC
	NAME_ASC
	NAME_DESC
}

scalar Instant

scalar Long

interface MediaItem {
	id: ID!
	title: String!
	path: String!
	size: Long!
	bucketId: ID!
	createdAt: Instant!
	updatedAt: Instant!
}

type Tag {
	id: ID!
	name: String!
	type: DataType!
	count: Int!
}

செயல்பாடுகள்

query

docCount

வினவலுக்குப் பொருந்தும் ஆவணங்களை எண்ணவும்.

graphql
query docCount($query: String!) {
  docCount(query: $query)
}
query

docExtGroups

தனித்துவமான அனைத்துக் கோப்பு நீட்சிகளையும் அவற்றின் எண்ணிக்கைகளையும் பட்டியலிடவும். ‘வகையால் வடிகட்டு’ UI உருவாக்கப் பயன்படுகிறது.

graphql
query docExtGroups($query: String!) {
  docExtGroups(query: $query) { ext count }
}
query

docs

ஆவணங்களைத் தேடவும். அனைத்தையும் பட்டியலிட query-ஐ வெறுமையாக விடவும்.

graphql
query docs($query: String!, $offset: Int!, $limit: Int!, $sortBy: DocSortBy!) {
  docs(query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { id title path extension size bucketId createdAt updatedAt }
}