# SDK Methods

The Teachfloor.js SDK provides five core methods for interacting with the platform.

## API.get()

Retrieve data from Teachfloor.

### Usage

```javascript
API.get(objectIdentifier)
```

### Parameters

- `objectIdentifier` (string): Identifier for the object to retrieve

### Available Objects

| Identifier | Description |
|------------|-------------|
| `auth.user` | Authenticated user details (ID, name, email, profile data) |

### Returns

Promise that resolves with the requested data or rejects on error.

### Example

```javascript
API.get('auth.user')
  .then(user => console.log('User:', user))
  .catch(error => console.error('Error:', error));
```

---

## API.on()

Listen for events within the Teachfloor platform.

### Usage

```javascript
API.on(eventIdentifier, callback)
```

### Parameters

- `eventIdentifier` (string): Event to listen for
- `callback` (function): Function called when event triggers

### Available Events

| Event | Description |
|-------|-------------|
| `environment.viewport.changed` | Viewport (page) changes within Teachfloor |
| `environment.path.changed` | URL path changes within Teachfloor |

### Example

```javascript
API.on('environment.viewport.changed', (viewport, objectContext) => {
  if (viewport === 'teachfloor.dashboard.course.detail') {
    console.log('Course page:', objectContext.course);
  }
});
```

---

## API.emit()

Trigger actions within the Teachfloor platform.

### Usage

```javascript
API.emit(action, parameters)
```

### Parameters

- `action` (string): Action identifier
- `parameters` (object): Action configuration

### Available Actions

| Action | Description | Parameters |
|--------|-------------|------------|
| `ui.toast.show` | Display a toast notification | `message` (string, required)<br>`autoClose` (number, optional)<br>`color` (string, optional): `gray`, `green`, `red` |
| `ui.drawer.show` | Show the app drawer | None |
| `ui.drawer.hide` | Hide the app drawer | None |
| `ui.drawer.toggle` | Toggle the app drawer visibility | None |

### Example

```javascript
// Show toast notification
API.emit('ui.toast.show', {
  message: 'Welcome to the course!',
  autoClose: 3000,
  color: 'green'
});

// Show drawer
API.emit('ui.drawer.show');
```

---

## API.set()

Store data in Teachfloor (internal use - available for first-party apps).

### Usage

```javascript
API.set(key, value, source)
```

### Parameters

- `key` (string): Storage key identifier
- `value` (any): Value to store
- `source` (string): Storage source - `appdata`, `userdata`, or `usercollection`

### Returns

Promise that resolves with the stored data or rejects on error.

---

## API.generate()

Generate AI content using Teachfloor's AI capabilities (beta feature).

### Usage

```javascript
API.generate(prompt, generationType)
```

### Parameters

- `prompt` (string): The generation prompt
- `generationType` (string): Type of generation (default: `ai/text-generate`)

### Returns

Promise that resolves with the generated content or rejects on error.

### Example

```javascript
API.generate('Write a course introduction', 'ai/text-generate')
  .then(text => console.log('Generated:', text))
  .catch(error => console.error('Error:', error));
```

---

## Summary

- **API.get()**: Retrieve data from Teachfloor
- **API.set()**: Store data (internal use)
- **API.on()**: Subscribe to platform events
- **API.emit()**: Trigger actions in Teachfloor
- **API.generate()**: Generate AI content (beta)

All methods use promises for asynchronous operations.