Application
Table of Contents
Interfaces
- AdditionInterface
- Interface for all addition types.
- AnimationInterface
- Interface for all ANF component animations.
- BehaviorInterface
- Interface for all ANF component behaviors.
- ConditionalInterface
- Interface for all conditional objects.
- ContentDisplayInterface
- Interface for all ANF content display types.
- SceneInterface
- Interface for all ANF scene types.
- FillInterface
- Interface for all fill types.
Classes
- AppleNewsClient
- Apple News Publisher API Client.
- Authenticator
- Handles HMAC-SHA256 authentication for Apple News API requests.
- CalendarEventAddition
- Calendar event addition for creating calendar events.
- ComponentLink
- Component link for making entire components tappable.
- LinkAddition
- Link addition for making text ranges tappable.
- AppearAnimation
- Appear animation for components.
- FadeInAnimation
- Fade-in animation for components.
- MoveInAnimation
- Move-in animation for components.
- ScaleFadeAnimation
- Scale-fade animation for components.
- Article
- Represents an Apple News Format (ANF) article document.
- BackgroundMotion
- BackgroundMotion behavior for background motion effects.
- BackgroundParallax
- BackgroundParallax behavior for scroll-based background parallax.
- Motion
- Motion behavior for device motion-based parallax.
- Parallax
- Parallax behavior for scroll-based parallax effects.
- Springy
- Springy behavior for device tilt-based movement.
- ARKit
- ARKit component for augmented reality experiences.
- ArticleLink
- Article link component.
- Aside
- Aside container component.
- Audio
- Audio component for audio content playback.
- Author
- Author name component.
- BannerAdvertisement
- Banner advertisement component.
- Body
- The standard text component for body paragraphs.
- Byline
- Byline component for publication date and contributor credits.
- Caption
- A standard text component for captions.
- Chapter
- Chapter container component.
- Component
- Base class for all Apple News Format (ANF) components.
- Container
- A container component used to group other components together.
- DataTable
- DataTable component for structured tabular data.
- Divider
- A visual separator line used between other components.
- EmbedWebVideo
- Embeds third-party video content (YouTube, Vimeo, etc.).
- FacebookPost
- Component for embedding Facebook posts.
- Figure
- Figure component for images with semantic meaning.
- FlexibleSpacer
- Flexible spacer component for dynamic spacing in horizontal stacks.
- Gallery
- Component for displaying a collection of images as a gallery.
- Header
- Header container component.
- Heading
- A heading component (supports levels 1 through 6).
- HTMLTable
- HTMLTable component for HTML-formatted tables.
- Illustrator
- Illustrator credit component.
- Image
- Generic image component.
- Component for embedding Instagram posts.
- Intro
- Introductory or deck text component.
- LinkButton
- A call-to-action button that links to an external URL or article section.
- Logo
- Logo component for brand or publication logos.
- Map
- Map component for displaying Apple Maps.
- MediumRectangleAdvertisement
- Medium rectangle advertisement component (MREC).
- Mosaic
- Mosaic component for multi-image tile layouts.
- Music
- Music component for Apple Music integration.
- Photo
- Component for displaying single images in an article.
- Photographer
- Photographer credit component.
- Place
- Place component for displaying a specific location.
- Podcast
- Podcast component for Apple Podcasts integration.
- Portrait
- Portrait component for face-optimized image cropping.
- Pullquote
- Component for highlighting a quote within an article.
- Quote
- Block quote component.
- ReplicaAdvertisement
- Replica advertisement component.
- Section
- Section container component.
- TextComponent
- Base class for all components that primarily contain text content.
- TikTok
- TikTok component for embedding TikTok videos.
- Title
- The main title component for an article.
- Tweet
- Component for embedding X/Twitter posts.
- Video
- Component for displaying native hosted videos.
- ConditionalAutoPlacement
- Conditional auto-placement configuration.
- ConditionalButton
- Conditional properties for button components.
- ConditionalComponent
- Conditional properties for any component.
- ConditionalComponentLayout
- Conditional properties for component layouts.
- ConditionalComponentStyle
- Conditional properties for component styles.
- ConditionalComponentTextStyle
- Conditional text style for component text.
- ConditionalContainer
- Conditional properties for container components.
- ConditionalDivider
- Conditional properties for divider components.
- ConditionalDocumentStyle
- Conditional properties for document styles.
- ConditionalSection
- Conditional properties for section components.
- ConditionalTableCellStyle
- Conditional properties for table cell styles.
- ConditionalTableRowStyle
- Conditional properties for table row styles.
- ConditionalText
- Conditional properties for text components.
- ConditionalTextStyle
- Conditional properties for text styles.
- Issue
- Issue information for magazine and periodical content.
- AdvertisementAutoPlacement
- Advertisement auto-placement configuration.
- AutoPlacement
- Auto-placement configuration for automatic component insertion.
- CollectionDisplay
- Collection display for grid-like component arrangements.
- Condition
- Condition object for conditional component properties.
- HorizontalStackDisplay
- Horizontal stack display for arranging components horizontally.
- Layout
- Defines the column system and base grid for an article.
- Metadata
- Article metadata for Apple News Format.
- FadingStickyHeader
- Fading sticky header scene.
- ParallaxScaleHeader
- Parallax scale header scene.
- ComponentShadow
- Shadow effect for components.
- ComponentTextStyle
- Detailed text styling options for components.
- CornerMask
- Rounded corner clipping for components.
- DocumentStyle
- Global styles applied to the entire article document.
- ColorStop
- Color stop for gradient fills.
- ImageFill
- Image background fill.
- LinearGradientFill
- Linear gradient background fill.
- RepeatableImageFill
- Tiled/repeatable image background fill.
- VideoFill
- Video background fill.
- ListItemStyle
- Style for bullet or numbered list items.
- TableBorder
- Border configuration for tables.
- TableCellStyle
- Style for table cells.
- TableColumnSelector
- Selector for targeting specific table columns.
- TableColumnStyle
- Style for table columns.
- TableRowSelector
- Selector for targeting specific table rows.
- TableRowStyle
- Style for table rows.
- TableStrokeStyle
- Stroke style for table borders and dividers.
- TableStyle
- Overall table style configuration.
- TextShadow
- Shadow effect for text.
- TextShadowOffset
- Offset positioning for text shadows.
- TextStrokeStyle
- Text outline/stroke styling.
- CaptionDescriptor
- Caption descriptor for media components.
- FormattedText
- Formatted text with styling support.
- InlineTextStyle
- Inline text style for specific ranges within text.
- AppleNewsException
- Base exception class for all errors returned by the Apple News API.
- AuthenticationException
- Exception thrown specifically when API authentication fails (401/403 errors).
- ArticleMetadata
- Builder for API-level metadata sent with Create and Update Article requests.
- MultipartBuilder
- Builds multipart/form-data request bodies for the Apple News API.
- ArticleLinks
- Links associated with an article response.
- ArticleResponse
- Complete response from Create, Read, and Update Article endpoints.
- Meta
- Meta object wrapping throttling information from Create/Update Article responses.
- Throttling
- Throttling information returned by Create and Update Article endpoints.
- Warning
- Warning message returned by the Apple News API for non-fatal issues.
Enums
- ArticleState
- Article processing states returned by the Apple News API.
- MaturityRating
- Content maturity rating for Apple News articles.